[PATCH] rust: sync: ordering: Fix dead link to LKMM explanation

Soham Metha posted 1 patch 2 weeks, 1 day ago
rust/kernel/sync/atomic/ordering.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] rust: sync: ordering: Fix dead link to LKMM explanation
Posted by Soham Metha 2 weeks, 1 day ago
Fix the reference to the LKMM 'explanation' document, using the `srctree/`
prefix triggers an htmldocs warning.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202508301445.KuPDLTET-lkp@intel.com/
Signed-off-by: Soham Metha <sohammetha01@gmail.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
 
 /// The annotation type for relaxed memory ordering, for the description of relaxed memory
 /// ordering, see [module-level documentation].
-- 
2.34.1
Re: [PATCH] rust: sync: ordering: Fix dead link to LKMM explanation
Posted by Alice Ryhl 2 weeks, 1 day ago
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@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202508301445.KuPDLTET-lkp@intel.com/
> Signed-off-by: Soham Metha <sohammetha01@gmail.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