Skip to content

Commit 2285eb2

Browse files
tgross35ojeda
authored andcommitted
docs: rust: clarify what 'rustup override' does
The behavior of 'rustup override' is not very well known. Add a small note 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@umich.edu> Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Link: https://lore.kernel.org/r/20230803060437.12157-3-tmgross@umich.edu [ Undid the `:` to `::` change. ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent 8cb4012 commit 2285eb2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Documentation/rust/quick-start.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ and run::
3838

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

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

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

0 commit comments

Comments
 (0)