Messages in this thread | | | Date | Mon, 8 Jan 2018 14:19:27 -0700 | From | Jonathan Corbet <> | Subject | Re: [PATCH 02/18] Documentation: document nospec helpers |
| |
On Mon, 8 Jan 2018 17:09:59 +0000 Mark Rutland <mark.rutland@arm.com> wrote:
> > I have just a couple of overall comments. > > > > - It would be nice if the document were done in RST and placed in the > > core-API manual, perhaps using kerneldoc comments for the macros > > themselves. It's already 99.9% RST now, so the changes required would > > be minimal. > > Is there any quickstart guide to RST that you can recommend?
http://docutils.sourceforge.net/docs/user/rst/quickref.html works reasonably well. We have some info in the kernel documentation as well, see http://static.lwn.net/kerneldoc/doc-guide/sphinx.html
Thanks,
jon
| |