[PATCH 2/2] docs: rust: clarify what 'rustup override' does

From: Trevor Gross
Date: Tue Jul 18 2023 - 02:01:50 EST


The behavior of 'rustup override' is not very well known. This patch is
a small edit that adds details about what it does, so users have a better
understanding of how it affects their system toolchain (i.e., it does
not affect system toolchain and only sets a directory-specific
override).

Signed-off-by: Trevor Gross <tmgross@xxxxxxxxx>
---
Documentation/rust/quick-start.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index bb67deb19100..700d37dcff5c 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -38,7 +38,9 @@ and run::

rustup override set $(scripts/min-tool-version.sh rustc)

-Otherwise, fetch a standalone installer from:
+This will configure your working directory to use the correct version of
+``rustc`` without affecting your default toolchain. If you are not using
+``rustup``, fetch a standalone installer from::

https://forge.rust-lang.org/infra/other-installation-methods.html#standalone

--
2.34.1