linux-kernel - Re: [PATCH] rust: sync: ordering: Fix dead link to LKMM explanation

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 for Android: free password hash cracker in your pocket

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

Message-ID: <aTFQnsTFuVO5DrYv@google.com>
Date: Thu, 4 Dec 2025 09:13:02 +0000
From: Alice Ryhl <aliceryhl@...gle.com>
To: Soham Metha <sohammetha01@...il.com>
Cc: linux-kernel-mentees@...ts.linuxfoundation.org, shuah@...nel.org, 
	skhan@...uxfoundation.org, linux-kernel@...r.kernel.org, 
	kernel test robot <lkp@...el.com>, Will Deacon <will@...nel.org>, Peter Zijlstra <peterz@...radead.org>, 
	Boqun Feng <boqun.feng@...il.com>, Mark Rutland <mark.rutland@....com>, Gary Guo <gary@...yguo.net>, 
	Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, 
	"Björn Roy Baron" <bjorn3_gh@...tonmail.com>, Benno Lossin <lossin@...nel.org>, 
	Andreas Hindborg <a.hindborg@...nel.org>, Trevor Gross <tmgross@...ch.edu>, 
	Danilo Krummrich <dakr@...nel.org>, rust-for-linux@...r.kernel.org
Subject: Re: [PATCH] rust: sync: ordering: Fix dead link to LKMM explanation

On Thu, Dec 04, 2025 at 02:02:22AM +0530, Soham Metha wrote:
> Fix the reference to the LKMM 'explanation' document, using the `srctree/`
> prefix triggers an htmldocs warning.
> 
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202508301445.KuPDLTET-lkp@intel.com/
> Signed-off-by: Soham Metha <sohammetha01@...il.com>
> ---
> No functional changes.
> 
>  rust/kernel/sync/atomic/ordering.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/rust/kernel/sync/atomic/ordering.rs b/rust/kernel/sync/atomic/ordering.rs
> index 3f103aa8db99..d71c4f582f75 100644
> --- a/rust/kernel/sync/atomic/ordering.rs
> +++ b/rust/kernel/sync/atomic/ordering.rs
> @@ -20,7 +20,7 @@
>  //!   described in "DEPENDENCY RELATIONS" in [`LKMM`]'s [`explanation`].
>  //!
>  //! [`LKMM`]: srctree/tools/memory-model/
> -//! [`explanation`]: srctree/tools/memory-model/Documentation/explanation.txt
> +//! [`explanation`]: tools/memory-model/Documentation/explanation.txt

Currently, when I view this on:

https://rust.docs.kernel.org/kernel/sync/atomic/ordering/index.html

the link goes to:

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt?h=v6.18

which is the source code of the relevant piece of documentation. Of
course, a better link would be:
https://docs.kernel.org/dev-tools/lkmm/docs/explanation.html

However, I think this patch would case the link to go to

https://rust.docs.kernel.org/kernel/sync/atomic/ordering/tools/memory-model/Documentation/explanation.txt

instead, which seems wrong.

Alice