Em Tue, 13 Sep 2016 03:12:09 +0200 Richard Sailer <richard@xxxxxxxxxxxxxxxxxx> escreveu: > I just saved the new .rst file and tested it with rst2html and rst2pdf. > Conversion ran without Errors, Markup/Layout looks sensible to me. > > Some nit-picking: > > + > > +BOOKS: (Not on-line) > > +-------------------- > > + > > + * Title: **Linux Device Drivers** > > + > > + :Author: Alessandro Rubini. > > + :Publisher: O'Reilly & Associates. > > + :Date: 1998. > > + :Pages: 439. > > + :ISBN: 1-56592-292-1 > > + > > It looks like every dot at the end of such a item line induces and line > break and an empty line between to items in this field list. > > This makes it a bit harder to read and since all the items in the > previous Sections had no dots at the end of the line these look > inconsistent. Hmm... I'm not noticing such issues when using Sphinx 1.4.6 to produce the output: https://mchehab.fedorapeople.org/development-process/kernel-docs.html https://mchehab.fedorapeople.org/development-process/latex/development-process.pdf Could this be a bug related to rst2html/rst2pdf toolchain? > > Indentation > ----------- > The original text (and the conversion) uses 5 spaces for indentation. > Perhaps 4 or 2 spaces would be nicer. Agreed. We're using 4 spaces on other documents. > > > + > > + * Name: **linux-kernel mailing list archives and search engines** > > [...] > > + :URL: http://marc.theaimsgroup.com/?l=linux-kernel > It looks like this mirror is down. But this is perhaps something for an > extra patch. Yeah, IMHO, it would be best to fix it on a separate patch. I didn't review all the links. Also, the text mentions that the latest version would be at: http://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html I noticed some differences between what's there and what's the Kernel. I suspect that they both were maintained in separate. So, maybe it is worth to check entry by entry. Also, at the end, it mentions that the last update was in 2005. So, I noticed that it lacks newer books, like this one: https://www.amazon.com/Essential-Device-Drivers-Sreekrishnan-Venkateswaran/dp/0132396556 IMHO, it would be worth to try to update it to point to some books written after 2005. > If desired I can send a patch for these things. Sure! > I don't know the > process-rule what to do in such a case. Sorry. Well, the usual rules apply, as described within this book :-) Just send the patch to linux-doc@xxxxxxxxxxxxxxx and to doc maintainer (corbet@xxxxxxx). Please c/c me on it, as such patch will depend on my series. So, I'll end applying it on my development tree. > Also: would a "Tested-By: .." line make sense in such a case? Good question. I guess so, as, despite being documentation, it is parsed by a toolchain to parse the enriched content. 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
