On 12/12/2023 07:43, Viresh Kumar wrote:
Rustup override is required to be set for the build directory and not
necessarily the kernel source tree (unless the build directory is its
subdir).
Clarify the same in quick-start guide.
Signed-off-by: Viresh Kumar <viresh.kumar@xxxxxxxxxx> > ---
V2:
- Made few changes based on review comments.
Documentation/rust/quick-start.rst | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index f382914f4191..7ea931f74e09 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -33,14 +33,18 @@ 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 (or use
+`--path=<build-dir>` argument to the `set` sub-command) and run::
rustup override set $(scripts/min-tool-version.sh rustc)
`scripts/min-tool-version.sh` won't exist within the build dir if the
option the user takes is "enter the kernel build directory", right? It
only works if they use the `--path` argument in the `rustup override
set` option.
I gave this a spin and works as expected, just thought I would mention
this given how users sometimes simply copy/paste and this may be confusing.
Tiago.
