aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2017-05-24 12:49:18 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2017-05-24 12:49:18 -0700
commitadeaacfa567b32401d3bef848b78d078bf4393ec (patch)
tree7486ba41d5e0f40e4b2e5b317b668b8db3b6041b /docs
parentcd5b47fceba4b78d16e584a6703f4ab837c040fd (diff)
downloadcryptography-adeaacfa567b32401d3bef848b78d078bf4393ec.tar.gz
cryptography-adeaacfa567b32401d3bef848b78d078bf4393ec.tar.bz2
cryptography-adeaacfa567b32401d3bef848b78d078bf4393ec.zip
allow global suppression of link flags (#3592)
CRYPTOGRAPHY_SUPPRESS_LINK_FLAGS will now suppress link flags regardless of platform. Additionally, CRYPTOGRAPHY_WINDOWS_LINK_LEGACY_OPENSSL is now the flag you need if you want to link against < 1.1.0 on windows.
Diffstat (limited to 'docs')
-rw-r--r--docs/development/getting-started.rst2
-rw-r--r--docs/installation.rst10
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst
index 66173d40..0d7c91ea 100644
--- a/docs/development/getting-started.rst
+++ b/docs/development/getting-started.rst
@@ -46,7 +46,7 @@ For example, with `Homebrew`_:
pip install --requirement ./dev-requirements.txt
Alternatively for a static build you can specify
-``CRYPTOGRAPHY_OSX_NO_LINK_FLAGS=1`` and ensure ``LDFLAGS`` points to the
+``CRYPTOGRAPHY_SUPPRESS_LINK_FLAGS=1`` and ensure ``LDFLAGS`` points to the
absolute path for the `OpenSSL`_ libraries before calling pip.
.. tip::
diff --git a/docs/installation.rst b/docs/installation.rst
index 8acac2ec..bbb69213 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -60,13 +60,13 @@ to include the proper locations. For example:
C:\> \path\to\vcvarsall.bat x86_amd64
C:\> set LIB=C:\OpenSSL-win64\lib;%LIB%
C:\> set INCLUDE=C:\OpenSSL-win64\include;%INCLUDE%
- C:\> set CRYPTOGRAPHY_WINDOWS_LINK_OPENSSL110=1
C:\> pip install cryptography
As of OpenSSL 1.1.0 the library names have changed from ``libeay32`` and
``ssleay32`` to ``libcrypto`` and ``libssl`` (matching their names on all other
-platforms). Due to this change when linking against 1.1.0 you **must** set
-``CRYPTOGRAPHY_WINDOWS_LINK_OPENSSL110`` or else installation will fail.
+platforms). ``cryptography`` links against the new 1.1.0 names by default. If
+you need to compile ``cryptography`` against an older version then you **must**
+set ``CRYPTOGRAPHY_WINDOWS_LINK_LEGACY_OPENSSL`` or else installation will fail.
If you need to rebuild ``cryptography`` for any reason be sure to clear the
local `wheel cache`_.
@@ -237,14 +237,14 @@ You can also build cryptography statically:
.. code-block:: console
$ brew install openssl@1.1
- $ env CRYPTOGRAPHY_OSX_NO_LINK_FLAGS=1 LDFLAGS="$(brew --prefix openssl@1.1)/lib/libssl.a $(brew --prefix openssl@1.1)/lib/libcrypto.a" CFLAGS="-I$(brew --prefix openssl@1.1)/include" pip install cryptography
+ $ env CRYPTOGRAPHY_SUPPRESS_LINK_FLAGS=1 LDFLAGS="$(brew --prefix openssl@1.1)/lib/libssl.a $(brew --prefix openssl@1.1)/lib/libcrypto.a" CFLAGS="-I$(brew --prefix openssl@1.1)/include" pip install cryptography
`MacPorts`_:
.. code-block:: console
$ sudo port install openssl
- $ env CRYPTOGRAPHY_OSX_NO_LINK_FLAGS=1 LDFLAGS="/opt/local/lib/libssl.a /opt/local/lib/libcrypto.a" CFLAGS="-I/opt/local/include" pip install cryptography
+ $ env CRYPTOGRAPHY_SUPPRESS_LINK_FLAGS=1 LDFLAGS="/opt/local/lib/libssl.a /opt/local/lib/libcrypto.a" CFLAGS="-I/opt/local/include" pip install cryptography
If you need to rebuild ``cryptography`` for any reason be sure to clear the
local `wheel cache`_.