diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2023-04-02 22:01:31 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-02 09:01:31 -0400 |
| commit | 5fef27733c6cf52d54626ca775c2899c31a3f65b (patch) | |
| tree | 190deee06154e09d65aae01548876cf3afd37daf /docs/development | |
| parent | 1e49cb9c13845ee973e74d1ffca6fe8ca47c0a35 (diff) | |
| download | cryptography-5fef27733c6cf52d54626ca775c2899c31a3f65b.tar.gz | |
update docs for macOS dev with rust openssl (#8653)
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/getting-started.rst | 22 |
1 files changed, 4 insertions, 18 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 782c73110..a4283469b 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -20,24 +20,9 @@ installed with ``pip``. OpenSSL on macOS ~~~~~~~~~~~~~~~~ -You must have installed `OpenSSL`_ via `Homebrew`_ or `MacPorts`_ and must set -``CFLAGS`` and ``LDFLAGS`` environment variables before running ``nox`` -otherwise pip will fail with include errors. - -For example, with `Homebrew`_: - -.. code-block:: console - - $ env LDFLAGS="-L$(brew --prefix openssl@1.1)/lib" \ - CFLAGS="-I$(brew --prefix openssl@1.1)/include" \ - nox -e tests -p py310 - -Alternatively for a static build you can specify -``CRYPTOGRAPHY_SUPPRESS_LINK_FLAGS=1`` and ensure ``LDFLAGS`` points to the -absolute path for the `OpenSSL`_ libraries before calling pip. - -.. tip:: - You will also need to set these values when `Building documentation`_. +You must have installed `OpenSSL`_ (via `Homebrew`_ , `MacPorts`_, or a custom +build) and must configure the build `as documented here`_ before calling +``nox`` or else pip will fail to compile. Running tests ------------- @@ -78,3 +63,4 @@ The HTML documentation index can now be found at .. _`pip`: https://pypi.org/project/pip/ .. _`sphinx`: https://pypi.org/project/Sphinx/ .. _`reStructured Text`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _`as documented here`: https://docs.rs/openssl/latest/openssl/#automatic
\ No newline at end of file |