aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-24 09:59:01 -0800
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-24 09:59:01 -0800
commitbb41bf4d798a6761889ea828f7d7f160f17b4132 (patch)
treed9e35f777378265000e2263052129fdd8c58144f
parent29ffbd94d2c97ec46950af0e4aa1c8e4c4548909 (diff)
parent917e82e2da0091e90307b20cfa8feaf2fb211ada (diff)
downloadcryptography-bb41bf4d798a6761889ea828f7d7f160f17b4132.tar.gz
cryptography-bb41bf4d798a6761889ea828f7d7f160f17b4132.tar.bz2
cryptography-bb41bf4d798a6761889ea828f7d7f160f17b4132.zip
Merge pull request #504 from alex/syntax-highlight
Mark that tehse are console sections so they syntax highlight
-rw-r--r--docs/hazmat/backends/openssl.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
index d305520a..926ec7d1 100644
--- a/docs/hazmat/backends/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -26,9 +26,11 @@ The options you need to add allow the linker to identify every symbol correctly
even when multiple versions of the library are linked into the same program. If
you are using your distribution's source packages these will probably be
patched in for you already, otherwise you'll need to use options something like
-this when configuring OpenSSL::
+this when configuring OpenSSL:
- ./config -Wl,--version-script=openssl.ld -Wl,-Bsymbolic-functions -fPIC shared
+.. code-block:: console
+
+ $ ./config -Wl,--version-script=openssl.ld -Wl,-Bsymbolic-functions -fPIC shared
You'll also need to generate your own ``openssl.ld`` file. For example::
@@ -45,13 +47,17 @@ Using your own OpenSSL on OS X
To link cryptography against a custom version of OpenSSL you'll need to set
``ARCHFLAGS``, ``LDFLAGS``, and ``CFLAGS``. OpenSSL can be installed via
-`Homebrew`_::
+`Homebrew`_:
+
+.. code-block:: console
+
+ $ brew install openssl
- brew install openssl
+Then install cryptography linking against the brewed version:
-Then install cryptography linking against the brewed version::
+.. code-block:: console
- env ARCHFLAGS="-arch x86_64" LDFLAGS="-L/usr/local/opt/openssl/lib" CFLAGS="-I/usr/local/opt/openssl/include" pip install cryptography
+ $ env ARCHFLAGS="-arch x86_64" LDFLAGS="-L/usr/local/opt/openssl/lib" CFLAGS="-I/usr/local/opt/openssl/include" pip install cryptography
.. _`OpenSSL`: https://www.openssl.org/