From: Jonathan Corbet <corbet@lwn.net>
To: Ignacio Encinas <ignacio@iencinas.com>,
linux-kernel-mentees@lists.linux.dev, skhan@linuxfoundation.org,
Marco Elver <elver@google.com>,
Dmitry Vyukov <dvyukov@google.com>
Cc: kasan-dev@googlegroups.com, workflows@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Ignacio Encinas <ignacio@iencinas.com>
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races" URL in kcsan.rst
Date: Wed, 12 Mar 2025 16:36:19 -0600 [thread overview]
Message-ID: <87o6y5lvvg.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250306-fix-plain-access-url-v1-1-9c653800f9e0@iencinas.com>
Ignacio Encinas <ignacio@iencinas.com> writes:
> Make the URL point to the "Plain Accesses and Data Races" section again
> and prevent it from becoming stale by adding a commit id to it.
>
> Signed-off-by: Ignacio Encinas <ignacio@iencinas.com>
> ---
> I noticed this while reviewing the documentation.
>
> The "fix" isn't perfect as the link might become stale because it points
> to a fixed commit. Alternatively, we could lose the line number
> altogether.
> ---
> Documentation/dev-tools/kcsan.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> index d81c42d1063eab5db0cba1786de287406ca3ebe7..8575178aa87f1402d777af516f5c0e2fc8a3379d 100644
> --- a/Documentation/dev-tools/kcsan.rst
> +++ b/Documentation/dev-tools/kcsan.rst
> @@ -203,7 +203,7 @@ they happen concurrently in different threads, and at least one of them is a
> least one is a write. For a more thorough discussion and definition, see `"Plain
> Accesses and Data Races" in the LKMM`_.
>
> -.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt#n1922
> +.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt?id=8f6629c004b193d23612641c3607e785819e97ab#n2164
>
This seems like an improvement over what we have, so I've applied it.
It would be best, of course, to get the memory-model documentation
properly into our built docs...someday...
Thanks,
jon
next prev parent reply other threads:[~2025-03-12 22:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-06 21:11 Ignacio Encinas
2025-03-12 22:36 ` Jonathan Corbet [this message]
2025-03-14 16:30 ` Ignacio Encinas Rubio
2025-03-15 2:41 ` Akira Yokosawa
2025-03-15 12:21 ` Ignacio Encinas Rubio
2025-03-17 23:03 ` Jonathan Corbet
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=87o6y5lvvg.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=dvyukov@google.com \
--cc=elver@google.com \
--cc=ignacio@iencinas.com \
--cc=kasan-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=workflows@vger.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox