linux-kernel - Re: [PATCH] docs: rust: Clarify that 'rustup override' applies to build directory

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 11 Dec 2023 10:12:37 +0000
From:   Benno Lossin <benno.lossin@...ton.me>
To:     Viresh Kumar <viresh.kumar@...aro.org>,
        "Andreas Hindborg (Samsung)" <nmi@...aspace.dk>
Cc:     Miguel Ojeda <ojeda@...nel.org>,
        Alex Gaynor <alex.gaynor@...il.com>,
        Wedson Almeida Filho <wedsonaf@...il.com>,
        Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
        Björn Roy Baron <bjorn3_gh@...tonmail.com>,
        Alice Ryhl <aliceryhl@...gle.com>,
        Jonathan Corbet <corbet@....net>,
        Vincent Guittot <vincent.guittot@...aro.org>,
        rust-for-linux@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: rust: Clarify that 'rustup override' applies to build directory

On 12/11/23 09:23, Viresh Kumar wrote:
> On 11-12-23, 09:09, Andreas Hindborg (Samsung) wrote:
>>
>> Thanks for fixing this Viresh!
>>
>> Viresh Kumar <viresh.kumar@...aro.org> writes:
>>
>>> 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::
>>>
>>>         rustup override set $(scripts/min-tool-version.sh rustc)
>>
>> How about just specifying the path here:
>>
>>          rustup override set --path=<build-dir> $(scripts/min-tool-version.sh rustc)
> 
> Hmm, this sounds good too. In that case the above line can be changed to:
> 
> "If ``rustup`` is being used, run::"
> 
> Looks okay ?

I think it should also mention that you do not need the
`--path=<build-dir>`. It might be confusing for new users who do not
know where the build directory is.
It might also work to put both commands there (i.e. with
`--path=<build-dir>` and without) and explaining what each of them do.

-- 
Cheers,
Benno