summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2021-02-08 10:18:13 -0500
committerGitHub <noreply@github.com>2021-02-08 09:18:13 -0600
commit5fdc9c1b8563c2ffe99d6dff3f0632fb9dc29936 (patch)
tree8a5e3cb9009e3f756c002a0ccd948d7ca821ca8f /docs
parent9aa369af8c02d86a096e8c5338faa5b83e5cf2ee (diff)
downloadcryptography-5fdc9c1b8563c2ffe99d6dff3f0632fb9dc29936.tar.gz
More aggressively point people at Rust version docs (#5782)
Diffstat (limited to 'docs')
-rw-r--r--docs/faq.rst4
-rw-r--r--docs/installation.rst2
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/faq.rst b/docs/faq.rst
index 7eec9c53b..4123a1cf8 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -123,7 +123,9 @@ Installing ``cryptography`` fails with ``error: Can not find Rust compiler``
Building ``cryptography`` from source requires you have :ref:`Rust installed
and available<installation:Rust>` on your ``PATH``. You may be able to fix this
by upgrading to a newer version of ``pip`` which will install a pre-compiled
-``cryptography`` wheel. If not, you'll need to install Rust.
+``cryptography`` wheel. If not, you'll need to install Rust. Follow the
+:ref:`instructions<installation:Rust>` to ensure you install a recent Rust
+version.
For the current release *only* you can temporarily bypass the requirement to
have Rust installed by setting the ``CRYPTOGRAPHY_DONT_BUILD_RUST`` environment
diff --git a/docs/installation.rst b/docs/installation.rst
index 7edd92432..e167f5af1 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -273,6 +273,8 @@ Building ``cryptography`` requires having a working Rust toolchain. The current
minimum supported Rust version is 1.45.0.
Instructions for installing Rust can be found on `the Rust Project's website`_.
+We recommend installing Rust with ``rustup`` (as documented by the Rust
+Project) in order to ensure you have a recent version.
.. _`Homebrew`: https://brew.sh
.. _`MacPorts`: https://www.macports.org