diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2015-07-04 12:59:30 -0400 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2015-07-04 12:59:30 -0400 |
| commit | 3e7093a0e24cf9e4fb83e41579e489262c60989d (patch) | |
| tree | a32f611a96eb7efbaf6718b75e3c20082452404c | |
| parent | a2571c6e6cc2128b0b5b3c33df9e40f8b1460ee6 (diff) | |
| parent | 47e1b6047efb72aab1fb9296dfd566f59440b752 (diff) | |
| download | cryptography-3e7093a0e24cf9e4fb83e41579e489262c60989d.tar.gz cryptography-3e7093a0e24cf9e4fb83e41579e489262c60989d.tar.bz2 cryptography-3e7093a0e24cf9e4fb83e41579e489262c60989d.zip | |
Merge pull request #2109 from reaperhulk/doc-osx-install
add some documentation around the requirement for xcode cli tools on mac
| -rw-r--r-- | docs/installation.rst | 17 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
2 files changed, 17 insertions, 1 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 1c25ff78..96e1e8de 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -125,8 +125,23 @@ You'll also need to generate your own ``openssl.ld`` file. For example:: You should replace the version string on the first line as appropriate for your build. +Building cryptography on OS X +----------------------------- + +Building cryptography requires the presence of a C compiler and development +headers. On OS X this is typically provided by Apple's Xcode development tools. +To install the Xcode command line tools on open a terminal window and run: + +.. code-block:: console + + $ xcode-select --install + +This will install a compiler (clang) along with the required development +headers. If you wish to compile against a more recent OpenSSL than the +version shipped with OS X see the next section. + 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 diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 235e08d4..1eed7c7a 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -63,3 +63,4 @@ unpadded unpadding Verisign wildcard +Xcode |