diff options
| author | Trevor Gross <tmgross@umich.edu> | 2023-08-03 02:04:37 -0400 |
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2023-08-21 00:36:41 +0200 |
| commit | 2285eb2f2429daadf9d57f08137b472139470aa9 (patch) | |
| tree | b11190ff3626385ab39cd1b3e4b5cc3c992ffdeb | |
| parent | 8cb40124cf923d4627d2e29b84dbff72e41fa0ef (diff) | |
| download | linux-2285eb2f2429daadf9d57f08137b472139470aa9.tar.gz linux-2285eb2f2429daadf9d57f08137b472139470aa9.tar.bz2 linux-2285eb2f2429daadf9d57f08137b472139470aa9.zip | |
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>
| -rw-r--r-- | Documentation/rust/quick-start.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst index a0a47a6f216b..f382914f4191 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 |