Re: Potential translation of LKMM docs into ReST

Alan Stern
2025-03-30T16:09:27Z

On Sun, Mar 30, 2025 at 01:07:23PM +0200, Ignacio Encinas Rubio wrote:
> Hello!
>
> There is interest [1] to get the memory model documentation into the
> built docs. Akira pointed out that this was discussed in the past [2].
>
> A couple of years have gone by, so I was wondering whether the decision
> to keep plain text documentation still applies.
>
> There is an "easy" way [3] to get the plain text documentation into the
> built docs, but I would be happy to work in a conversion into ReST if
> that's what you want :)
>
> Ccing people involved in [2]
>
> Thanks!
>
> [1] https://lore.kernel.org/all/87o6y5lvvg.fsf@trenco.lwn.net/
> [2] https://lore.kernel.org/lkml/20190901133530.GL4125@linux.ibm.com/
> [3] https://lore.kernel.org/all/20220927160559.97154-7-corbet@lwn.net/

I have no great interest in seeing the memory model documentation
translated into ReST, but you're welcome to try it and see how it comes
out if you want. Some of the files are likely to be easier to convert
than others.

The only restriction I will insist on is that if the resulting ReST
source files end up being unreadable because of all the markup they
contain then we must keep the original plain text files too.

Alan