Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races" URL in kcsan.rst
From: Ignacio Encinas Rubio
Date: Sat Mar 15 2025 - 08:22:08 EST
On 15/3/25 3:41, Akira Yokosawa wrote:
> This might be something Jon would like to keep secret, but ...
>
> See the message and the thread it belongs at:
>
> https://lore.kernel.org/lkml/Pine.LNX.4.44L0.1907310947340.1497-100000@xxxxxxxxxxxxxxxxxxxx/
>
> It happened in 2019 responding to Mauro's attempt to conversion of
> LKMM docs.
>
> I haven't see any change in sentiment among LKMM maintainers since.
Thanks for the information!
> Your way forward would be to keep those .txt files *pure plain text"
> and to convert them on-the-fly into reST. Of course only if such an
> effort sounds worthwhile to you.
With this you mean producing a .rst from the original .txt file using an
script before building the documentation, right? I'm not sure how hard
this is, but I can look into it.
> Another approach might be to include those docs literally.
> Similar approach has applied to
>
> Documentation/
> atomic_t.txt
> atomic_bitops.txt
> memory-barriers.txt
Right, I got to [1].
It looks like there are several options here:
A) Include the text files like in [1]
B) Explore the "on-the-fly" translation
C) Do A) and then B)
Does any of the above sound good, Jon?
Thank you both for your time
[1] https://lore.kernel.org/all/20220927160559.97154-7-corbet@xxxxxxx/