On 12/10/23 22:47, Viresh Kumar wrote:
On 08-12-23, 18:04, Benno Lossin wrote:
Shouldn't this be "Note that the override only applies to the current
working directory (and its sub-directories)."?
I think it would also be useful to continue with this: "But in order
to build the kernel, this override must affect the build directory.".
And then you could also mention that in the default location for the
build directory is in the repository.
Based on feedback from Miguel and Benno, how about this instead ?
diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index f382914f4191..dee787f92d26 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -33,14 +33,17 @@ A particular version of the Rust compiler is required. Newer versions may or
may not work because, for the moment, the kernel depends on some unstable
Rust features.
-If ``rustup`` is being used, enter the checked out source code directory
-and run::
+If ``rustup`` is being used, enter the kernel build directory and run::
That "enter the kernel build directory" phrase is much better than the
"enter the checked out source code directory".
I feel confident saying this, because I just read this document over the
weekend, while getting set up to build rust for Linux. And this phrase
was a little jarring and weird to me.
This is after all a minor point, but it's nice to polish up this getting
started guide. It's already a concise and excellent guide, by the way.
thanks,
--
John Hubbard
NVIDIA
rustup override set $(scripts/min-tool-version.sh rustc)
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:
+``rustc`` without affecting your default toolchain.
+
+Note that the override applies to the current working directory (and its
+sub-directories).
+
+If you are not using ``rustup``, fetch a standalone installer from:
https://forge.rust-lang.org/infra/other-installation-methods.html#standalone
