linux-kernel - [PATCH 0/4] Add ABI to the Documentation's admin guide

lists.openwall.net		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 linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Fri,  2 Dec 2016 11:12:46 -0200
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Hans Verkuil <hans.verkuil@...co.com>,
        Markus Heiser <markus.heiser@...marIT.de>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Markus Heiser <markus.heiser@...marit.de>
Subject: [PATCH 0/4] Add ABI to the Documentation's admin guide

That's the second attempt to add support for the Kernel ABI
at the Documentation's admin guide.

The previous approach was based on a generic extension that
calls a random script.

This patch series gets rid of the generic script execution by
hardcoding the extension to run a get_abi.pl script.

Such script parses the file contents at the ABI directory or
its sub-directories and produce a ReST output.

Adding the ABI description is then a matter or just adding a
kernel-abi tag inside a file, like:

	.. kernel-abi:: $srctree/Documentation/ABI/

We could, instead, be doing:

abi-obsolete.rst file:
	.. kernel-abi:: $srctree/Documentation/ABI/obsolete

abi-stable.rst file:
	.. kernel-abi:: $srctree/Documentation/ABI/stable
...

In order to splitting the ABI contents on multiple files, reducing
the size of the ABI output. Not sure what would be the best.

Markus Heiser (2):
  doc-rst: customize RTD theme; literal-block
  doc-rst: reST-directive kernel-cmd / include contentent from scripts

Mauro Carvalho Chehab (2):
  scripts: add an script to parse the ABI files
  doc-rst: add ABI documentation to the admin-guide book

 Documentation/admin-guide/abi.rst               |   5 +
 Documentation/admin-guide/index.rst             |   1 +
 Documentation/conf.py                           |   2 +-
 Documentation/sphinx-static/theme_overrides.css |   7 +
 Documentation/sphinx/kernel_abi.py              | 155 +++++++++++++++++
 scripts/get_abi.pl                              | 212 ++++++++++++++++++++++++
 6 files changed, 381 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/admin-guide/abi.rst
 create mode 100644 Documentation/sphinx/kernel_abi.py
 create mode 100755 scripts/get_abi.pl

-- 
2.9.3