Skip to contentSkip to conversation

rust: sync: ordering: Fix dead link to LKMM explanation

PATCH In review Soham Metha 2 participants 2 messages Dec 3, 2025 – Dec 4, 2025

Subsystems (3)
Rust Atomic infrastructure Rust sync
lore
Share & tools
lore

Soham Metha

author
#0 lore raw

PATCH 1/1 rust: sync: ordering: Fix dead link to LKMM explanation

Fix the reference to the LKMM 'explanation' document, using the srctree/ prefix triggers an htmldocs warning.

Reported-by kernel test robot <[email protected]>
Closes https://lore.kernel.org/oe-kbuild-all/[email protected]/ open here
Signed-off-by Soham Metha <[email protected]>

---
No functional changes.

 rust/kernel/sync/atomic/ordering.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/sync/atomic/ordering.rs +1 -1
index 3f103aa8db99..d71c4f582f75 100644
@@ -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].
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 17 lines · Soham Metha

Fix the reference to the LKMM 'explanation' document, using the srctree/ prefix triggers an htmldocs warning.

Reported-by kernel test robot <[email protected]>
Closes https://lore.kernel.org/oe-kbuild-all/[email protected]/ open here
Signed-off-by Soham Metha <[email protected]>

---
No functional changes.

 rust/kernel/sync/atomic/ordering.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rust/kernel/sync/atomic/ordering.rs +0 -0
index 3f103aa8db99..d71c4f582f75 100644

rust/kernel/sync/atomic/ordering.rs line 23

Quoted 5 lines
rust/kernel/sync/atomic/ordering.rs +1 -1
@@ -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