Em Wed, 16 Nov 2016 16:35:24 -0700 Jonathan Corbet <corbet@xxxxxxx> escreveu: > On Tue, 8 Nov 2016 06:27:08 -0200 > Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote: > > > Provide a man page for parse-headers.pl, describing > > how to use it. > > > > The documentation on ReST format was generated via pod2rst: > > http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst > > Gee, this is still sitting in my folder, somehow...:) Sorry about that. No problem! > > Can I make one request? I think this should be part of > kernel-documentation rather than another top-level, standalone document. > Any chance of doing that? Yeah, sure! I added it as a separate rst file due to to two reasons: 1) kernel-documentation.rst is becoming a big file with several different stuff on it. IMHO, the best would be to create a directory for it, add an index.rst on it, and split it into several files; 2) it is easier to call pod2rst to convert the perl POD documentation into a separate rst file. Ok, I can always copy the content to some other rst file, but it would be simpler to maintain as a separate .rst. Provided that you're OK with the contents, I can put its contents inside the kernel-documentation.rst. Yet, my preference would be to break kernel-documentation.rst into separate files, like: - kernel-documentation/index.rst - kernel-documentation/sphinx.rst - kernel-documentation/kernel-docs.rst - kernel-documentation/parse-headers.rst And add a kernel-documentation/conf.py, to allow building a PDF file with it with SPHINXDIRS=kernel-documentation. The side effect of such change is that we'll have a kernel-documentation.pdf file and be able to build just this book in separate. Another advantage is that we'll have one file per chapter, making easier to add new contents to the book without touching on the other chapters. What do you prefer? Regards, Mauro -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
