summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohn Jones <john@exthilion.org>2021-09-18 18:30:58 -0700
committerGitHub <noreply@github.com>2021-09-19 09:30:58 +0800
commit6542c2f2f4beab41e883e860d3b3554993231bf4 (patch)
tree7910f82930ac31a57230ff03e5758422f4e62ba1 /docs
parent1a0ba3e79d1f52cf1967e4ac177cdae788d9829a (diff)
downloadcryptography-6542c2f2f4beab41e883e860d3b3554993231bf4.tar.gz
per discussion in #6236 (#6254)
Diffstat (limited to 'docs')
-rw-r--r--docs/faq.rst5
-rw-r--r--docs/installation.rst27
2 files changed, 15 insertions, 17 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
index cfa2952fe..befe3942e 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -78,9 +78,8 @@ OpenSSL. If you see this error it is likely because your copy of ``pip`` is too
old to find our wheel files. Upgrade your ``pip`` with ``pip install -U pip``
and then try to install ``cryptography`` again.
-Users on PyPy, unusual CPU architectures, or distributions of Linux using
-``musl`` (like Alpine) will need to compile ``cryptography`` themselves. Please
-view our :doc:`/installation` documentation.
+Users on unusual CPU architectures will need to compile ``cryptography``
+themselves. Please view our :doc:`/installation` documentation.
``cryptography`` raised an ``InternalError`` and I'm not sure what to do?
-------------------------------------------------------------------------
diff --git a/docs/installation.rst b/docs/installation.rst
index 65a8d0124..a3b0cafdf 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -87,17 +87,16 @@ Building cryptography on Linux
``cryptography`` ships ``manylinux`` wheels (as of 2.0) so all dependencies
are included. For users on **pip 19.0** or above running on a ``manylinux2010``
-(or greater) compatible distribution (almost everything **except Alpine**) all
+(or greater) compatible distribution (or **pip 21.2.4** for ``musllinux``) all
you should need to do is:
.. code-block:: console
$ pip install cryptography
-If you are on Alpine or just want to compile it yourself then
-``cryptography`` requires a C compiler, a Rust compiler, headers for Python (if
-you're not using ``pypy``), and headers for the OpenSSL and ``libffi`` libraries
-available on your system.
+If you want to compile ``cryptography`` yourself you'll need a C compiler, a
+Rust compiler, headers for Python (if you're not using ``pypy``), and headers
+for the OpenSSL and ``libffi`` libraries available on your system.
On all Linux distributions you will need to have :ref:`Rust installed and
available<installation:Rust>`.
@@ -198,15 +197,15 @@ Static Wheels
~~~~~~~~~~~~~
Cryptography ships statically-linked wheels for macOS, Windows, and Linux (via
-``manylinux``). This allows compatible environments to use the most recent
-OpenSSL, regardless of what is shipped by default on those platforms. Some
-Linux distributions (most notably Alpine) are not ``manylinux`` compatible so
-we cannot distribute wheels for them.
-
-However, you can build your own statically-linked wheels that will work on your
-own systems. This will allow you to continue to use relatively old Linux
-distributions (such as LTS releases), while making sure you have the most
-recent OpenSSL available to your Python programs.
+``manylinux`` and ``musllinux``). This allows compatible environments to use
+the most recent OpenSSL, regardless of what is shipped by default on those
+platforms.
+
+If you are using a platform not covered by our wheels, you can build your own
+statically-linked wheels that will work on your own systems. This will allow
+you to continue to use relatively old Linux distributions (such as LTS
+releases), while making sure you have the most recent OpenSSL available to
+your Python programs.
To do so, you should find yourself a machine that is as similar as possible to
your target environment (e.g. your production environment): for example, spin