From: Alan Stern <stern@rowland.harvard.edu>
To: Ignacio Encinas Rubio <ignacio@iencinas.com>
Cc: lkmm@lists.linux.dev, mchehab+huawei@kernel.org,
paulmck@kernel.org, joel@joelfernandes.org,
Akira Yokosawa <akiyks@gmail.com>,
linux-kernel-mentees@lists.linux.dev, peterz@infradead.org,
corbet@lwn.net, Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: Potential translation of LKMM docs into ReST
Date: Sun, 30 Mar 2025 12:09:22 -0400 [thread overview]
Message-ID: <16aa2173-afb2-4781-b1b0-a248b1f16a9f@rowland.harvard.edu> (raw)
In-Reply-To: <837b4d83-b91f-40d1-995a-aa3c5a925b0b@iencinas.com>
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
next prev parent reply other threads:[~2025-03-30 16:09 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-30 11:07 Potential translation of LKMM docs into ReST Ignacio Encinas Rubio
2025-03-30 16:09 ` Alan Stern [this message]
2025-03-30 17:52 ` Mauro Carvalho Chehab
2025-05-06 2:50 ` [PATCH] lkmm: docs: Put LKMM documentation into dev-tools book Akira Yokosawa
2025-05-07 0:07 ` Paul E. McKenney
2025-06-09 22:03 ` Jonathan Corbet
2025-06-10 2:11 ` Akira Yokosawa
2025-06-10 8:13 ` Mauro Carvalho Chehab
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=16aa2173-afb2-4781-b1b0-a248b1f16a9f@rowland.harvard.edu \
--to=stern@rowland.harvard.edu \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=ignacio@iencinas.com \
--cc=joel@joelfernandes.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=lkmm@lists.linux.dev \
--cc=mchehab+huawei@kernel.org \
--cc=paulmck@kernel.org \
--cc=peterz@infradead.org \
--cc=skhan@linuxfoundation.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).