Em Thu, 13 Apr 2017 07:08:43 -0300 Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> escreveu: > That's the third attempt to add support for the Kernel ABI > at the Documentation's admin guide. > > The first approach was based on a generic extension that > calls a random script. This one is based on a new Sphinx > extension with adds a symbol specific for parsing ABI > symbols. > > It adds a new script (scripts/get_abi.pl) with can either > search for ABI symbols that match a regular expression or > outputs the entire documentation found inside a directory > as a ReST book. > > Adding the ABI description to the Linux documentation is > as easy as adding a tab like: > > .. kernel-abi:: $srctree/Documentation/ABI/obsolete > > On version 3, I improved the script to better parse the > ABI descriptions. On this version, it will identify if the > description can be handled as a normal text. If so, it will > escape characters that has special meaning on Sphinx. > If it detects that the description syntax is too complex, > it outputs inside a literal block. > > Also on version 3, I opted to use 4 separate sections, one > for each type of symbol. It also add an entry with the name > of each ABI file, with has cross-references to the symbols > defined on each file. > > The parser was also improved to handle any content at the > files that are before the ABI tags. The HTML formatted result can be seen at: http://www.infradead.org/~mchehab/kernel_docs/admin-guide/abi.html And the PDF formatted result at (pages 151 to 565): http://www.infradead.org/~mchehab/kernel_docs_pdf/linux-user.pdf Thanks, 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
