Re: [PATCH v3 00/33] Convert files to ReST - part 1
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Date: 2019-06-09 12:29:54
Also in:
bpf, linux-doc, linux-riscv, lkml
Em Sun, 9 Jun 2019 11:16:43 +0200 Heiko Carstens [off-list ref] escreveu:
On Sat, Jun 08, 2019 at 11:26:50PM -0300, Mauro Carvalho Chehab wrote:quoted
This is the first part of a series I wrote sometime ago where I manually convert lots of files to be properly parsed by Sphinx as ReST files. As it touches on lot of stuff, this series is based on today's docs-next + linux-next, at tag next-20190607. I have right now about 85 patches with this undergoing work. That's because I opted to do ~1 patch per converted directory. That sounds too much to be send on a single round. So, I'm opting to split it on 3 parts. Those patches should probably be good to be merged either by subsystem maintainers or via the docs tree. I opted to mark new files not included yet to the main index.rst (directly or indirectly ) with the :orphan: tag, in order to avoid adding warnings to the build system. This should be removed after we find a "home" for all the converted files within the new document tree arrangement. Both this series and the next parts are on my devel git tree, at: https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v4 The final output in html (after all patches I currently have, including the upcoming series) can be seen at: https://www.infradead.org/~mchehab/rst_conversion/Will there be a web page (e.g. kernel.org), which contains always the latest upstream version?
Yes: https://www.kernel.org/doc/html/latest/ I guess this one is based on Linus tree. Jon also maintains a version at: https://static.lwn.net/kerneldoc/ I guess that one is based on docs-next branch from the Docs tree. Btw, if you want to build it for yourself, you could use: make htmldocs If your system doesn't have all dependencies, it will give the hints about how to install them.
quoted
docs: Debugging390.txt: convert table to ascii artwork docs: s390: convert docs to ReST and rename to *.rst s390: include/asm/debug.h add kerneldoc markupsI can pick these up for s390. Or do you want to send the whole series in one go upstream?
Yeah, feel free to pick them via the s390 tree. Regards, Mauro Thanks, Mauro Thanks, Mauro