All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	LKML <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Hans Verkuil <hans.verkuil@cisco.com>,
	Markus Heiser <markus.heiser@darmarIT.de>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Markus Heiser <markus.heiser@darmarIT.de>
Subject: [PATCH 0/4] Add ABI to the Documentation's admin guide
Date: Fri,  2 Dec 2016 11:12:46 -0200	[thread overview]
Message-ID: <cover.1480683879.git.mchehab@s-opensource.com> (raw)

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

             reply	other threads:[~2016-12-02 13:13 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-02 13:12 Mauro Carvalho Chehab [this message]
2016-12-02 13:12 ` [PATCH 1/4] doc-rst: customize RTD theme; literal-block Mauro Carvalho Chehab
2016-12-02 13:12 ` [PATCH 2/4] doc-rst: reST-directive kernel-cmd / include contentent from scripts Mauro Carvalho Chehab
2016-12-02 13:12 ` [PATCH 3/4] scripts: add an script to parse the ABI files Mauro Carvalho Chehab
2016-12-02 13:12 ` [PATCH 4/4] doc-rst: add ABI documentation to the admin-guide book Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1480683879.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=hans.verkuil@cisco.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarIT.de \
    --cc=mchehab@infradead.org \
    --cc=mchehab@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.