2023-07-18 06:09:04

by Trevor Gross

[permalink] [raw]
Subject: [PATCH 0/2] docs: rust: update instructions on obtaining 'core' source

This changes the suggested method of obtaining Rust's source to using the
tarball rather than a full clone, and adds a clarification about 'rustup
override'.

Trevor Gross (2):
docs: rust: update instructions for obtaining 'core' source
docs: rust: clarify what 'rustup override' does

Documentation/rust/quick-start.rst | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)

--
2.34.1



2023-07-18 06:20:36

by Trevor Gross

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

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 <[email protected]>
---
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


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

On 7/18/23 02:44, Trevor Gross wrote:
> 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 <[email protected]>
> ---
> [...]
Reviewed-by: Martin Rodriguez Reboredo <[email protected]>

2023-07-20 14:05:43

by Alice Ryhl

[permalink] [raw]
Subject: Re: [PATCH 2/2] docs: rust: clarify what 'rustup override' does

> 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 <[email protected]>

Reviewed-by: Alice Ryhl <[email protected]>