aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2017-03-15 12:21:45 -0400
committerPaul Kehrer <paul.l.kehrer@gmail.com>2017-03-15 12:21:45 -0400
commit06049448d94cf8a73c43755e6b929b4f871e2cbd (patch)
treeedc1f98717452c7211091d34ef0521b00b82c8a6 /docs
parent6ca6f4d9366b22d4f026723789dab19f99e5be44 (diff)
downloadcryptography-06049448d94cf8a73c43755e6b929b4f871e2cbd.tar.gz
cryptography-06049448d94cf8a73c43755e6b929b4f871e2cbd.tar.bz2
cryptography-06049448d94cf8a73c43755e6b929b4f871e2cbd.zip
Be on brand: it's macOS (#3456)
* Be on brand: it's macOS * line wrap
Diffstat (limited to 'docs')
-rw-r--r--docs/doing-a-release.rst8
-rw-r--r--docs/faq.rst6
-rw-r--r--docs/hazmat/backends/commoncrypto.rst4
-rw-r--r--docs/hazmat/backends/openssl.rst2
-rw-r--r--docs/hazmat/bindings/commoncrypto.rst2
-rw-r--r--docs/security.rst2
6 files changed, 12 insertions, 12 deletions
diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst
index 8e9222e0..2da2c80a 100644
--- a/docs/doing-a-release.rst
+++ b/docs/doing-a-release.rst
@@ -6,8 +6,8 @@ Doing a release of ``cryptography`` requires a few steps.
Verifying and upgrading OpenSSL version
---------------------------------------
-The release process uses a static build for Windows and OS X wheels. Check that
-the Windows and OS X Jenkins builders have the latest version of OpenSSL
+The release process uses a static build for Windows and macOS wheels. Check
+that the Windows and macOS Jenkins builders have the latest version of OpenSSL
installed before performing the release. If they do not:
Upgrading Windows
@@ -16,8 +16,8 @@ Upgrading Windows
Run the ``openssl-release-1.1`` Jenkins job, then copy the resulting artifacts
to the Windows builders and unzip them in the root of the file system.
-Upgrading OS X
-~~~~~~~~~~~~~~
+Upgrading macOS
+~~~~~~~~~~~~~~~
``brew update`` and then ``brew upgrade openssl@1.1 --build-bottle`` to
install a 64-bit only library compatible with all Intel Macs.
diff --git a/docs/faq.rst b/docs/faq.rst
index 4327d11a..4a9fd5cd 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -14,10 +14,10 @@ to NaCl.
If you prefer NaCl's design, we highly recommend `PyNaCl`_.
-Compiling ``cryptography`` on OS X produces a ``fatal error: 'openssl/aes.h' file not found`` error
----------------------------------------------------------------------------------------------------
+Compiling ``cryptography`` on macOS produces a ``fatal error: 'openssl/aes.h' file not found`` error
+----------------------------------------------------------------------------------------------------
-This happens because OS X 10.11 no longer includes a copy of OpenSSL.
+This happens because macOS 10.11 no longer includes a copy of OpenSSL.
``cryptography`` now provides wheels which include a statically linked copy of
OpenSSL. You're seeing this error because your copy of pip is too old to find
our wheel files. Upgrade your copy of pip with ``pip install -U pip`` and then
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst
index a6eb490b..e976b6f7 100644
--- a/docs/hazmat/backends/commoncrypto.rst
+++ b/docs/hazmat/backends/commoncrypto.rst
@@ -3,8 +3,8 @@
CommonCrypto backend
====================
-The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The
-CommonCrypto backend is only supported on OS X versions 10.8 and above.
+The `CommonCrypto`_ C library provided by Apple on macOS and iOS. The
+CommonCrypto backend is only supported on macOS versions 10.8 and above.
.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
index 22807f1c..897a05cd 100644
--- a/docs/hazmat/backends/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -92,7 +92,7 @@ When importing only the binding it is added to the engine list but
OS random sources
-----------------
-On OS X and FreeBSD ``/dev/urandom`` is an alias for ``/dev/random`` and
+On macOS and FreeBSD ``/dev/urandom`` is an alias for ``/dev/random`` and
utilizes the `Yarrow`_ algorithm.
On Windows the implementation of ``CryptGenRandom`` depends on which version of
diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst
index d5a739c8..63e734c6 100644
--- a/docs/hazmat/bindings/commoncrypto.rst
+++ b/docs/hazmat/bindings/commoncrypto.rst
@@ -8,7 +8,7 @@ CommonCrypto binding
.. versionadded:: 0.2
These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is only
-available on Mac OS X versions 10.8 and above.
+available on macOS versions 10.8 and above.
.. class:: cryptography.hazmat.bindings.commoncrypto.binding.Binding()
diff --git a/docs/security.rst b/docs/security.rst
index ff0a84a4..67c3d33b 100644
--- a/docs/security.rst
+++ b/docs/security.rst
@@ -64,7 +64,7 @@ New releases for OpenSSL updates
--------------------------------
As of version 0.5, ``cryptography`` statically links OpenSSL on Windows, and as
-of version 1.0.1 on OS X, to ease installation. Due to this, ``cryptography``
+of version 1.0.1 on macOS, to ease installation. Due to this, ``cryptography``
will release a new version whenever OpenSSL has a security or bug fix release to
avoid shipping insecure software.