From: Alice Ryhl <aliceryhl@google.com>
To: Soham Metha <sohammetha01@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org, shuah@kernel.org,
skhan@linuxfoundation.org, linux-kernel@vger.kernel.org,
"kernel test robot" <lkp@intel.com>,
"Will Deacon" <will@kernel.org>,
"Peter Zijlstra" <peterz@infradead.org>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Mark Rutland" <mark.rutland@arm.com>,
"Gary Guo" <gary@garyguo.net>, "Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
rust-for-linux@vger.kernel.org
Subject: Re: [PATCH] rust: sync: ordering: Fix dead link to LKMM explanation
Date: Thu, 4 Dec 2025 09:13:02 +0000 [thread overview]
Message-ID: <aTFQnsTFuVO5DrYv@google.com> (raw)
In-Reply-To: <20251203203222.70415-1-sohammetha01@gmail.com>
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
prev parent reply other threads:[~2025-12-04 9:13 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-03 20:32 [PATCH] rust: sync: ordering: Fix dead link to LKMM explanation Soham Metha
2025-12-04 9:13 ` Alice Ryhl [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aTFQnsTFuVO5DrYv@google.com \
--to=aliceryhl@google.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=dakr@kernel.org \
--cc=gary@garyguo.net \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=lossin@kernel.org \
--cc=mark.rutland@arm.com \
--cc=ojeda@kernel.org \
--cc=peterz@infradead.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=shuah@kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=sohammetha01@gmail.com \
--cc=tmgross@umich.edu \
--cc=will@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.