lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  PHC 
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date:   Thu, 13 Apr 2017 08:02:45 -0300
From:   Mauro Carvalho Chehab <>
To:     Linux Doc Mailing List <>,
        Jonathan Corbet <>
Cc:     Markus Heiser <>,
        Mauro Carvalho Chehab <>,
        LKML <>,
        Greg Kroah-Hartman <>,
        Kees Cook <>,
        Anton Vorontsov <>,
        Colin Cross <>,
        Tony Luck <>
Subject: Re: [PATCH v2 00/11] Documentation: Add ABI to the admin guide

Em Thu, 13 Apr 2017 07:08:43 -0300
Mauro Carvalho Chehab <> 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/ 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:

And the PDF formatted result at (pages 151 to 565):


Powered by blists - more mailing lists