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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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


--
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



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux