From: Kees Cook <keescook@chromium.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Kees Cook <keescook@chromium.org>,
Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/2] docs: Programmatically render MAINTAINERS into ReST
Date: Tue, 1 Oct 2019 11:25:30 -0700 [thread overview]
Message-ID: <20191001182532.21538-1-keescook@chromium.org> (raw)
v1: https://lore.kernel.org/lkml/20190924230208.12414-1-keescook@chromium.org
v2: fix python2 utf-8 issue thanks to Jonathan Corbet
Commit log from Patch 2 repeated here for cover letter:
In order to have the MAINTAINERS file visible in the rendered ReST
output, this makes some small changes to the existing MAINTAINERS file
to allow for better machine processing, and adds a new Sphinx directive
"maintainers-include" to perform the rendering.
Features include:
- Per-subsystem reference links: subsystem maintainer entries can be
trivially linked to both internally and external. For example:
https://www.kernel.org/doc/html/latest/process/maintainers.html#secure-computi
ng
- Internally referenced .rst files are linked so they can be followed
when browsing the resulting rendering. This allows, for example, the
future addition of maintainer profiles to be automatically linked.
- Field name expansion: instead of the short fields (e.g. "M", "F",
"K"), use the indicated inline "full names" for the fields (which are
marked with "*"s in MAINTAINERS) so that a rendered subsystem entry
is more human readable. Email lists are additionally comma-separated.
For example:
SECURE COMPUTING
Mail: Kees Cook <keescook@chromium.org>
Reviewer: Andy Lutomirski <luto@amacapital.net>,
Will Drewry <wad@chromium.org>
SCM: git git://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.g
it seccomp
Status: Supported
Files: kernel/seccomp.c include/uapi/linux/seccomp.h
include/linux/seccomp.h tools/testing/selftests/seccomp/*
tools/testing/selftests/kselftest_harness.h
userspace-api/seccomp_filter
Content regex: \bsecure_computing \bTIF_SECCOMP\b
---
Kees Cook (2):
doc-rst: Reduce CSS padding around Field
doc-rst: Programmatically render MAINTAINERS into ReST
Documentation/conf.py | 3 +-
Documentation/process/index.rst | 1 +
Documentation/process/maintainers.rst | 1 +
.../sphinx-static/theme_overrides.css | 10 +
Documentation/sphinx/maintainers_include.py | 197 ++++++++++++++++++
MAINTAINERS | 62 +++---
6 files changed, 243 insertions(+), 31 deletions(-)
create mode 100644 Documentation/process/maintainers.rst
create mode 100755 Documentation/sphinx/maintainers_include.py
--
2.17.1
next reply other threads:[~2019-10-01 18:25 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-01 18:25 Kees Cook [this message]
2019-10-01 18:25 ` [PATCH v2 1/2] doc-rst: Reduce CSS padding around Field Kees Cook
2019-10-01 18:25 ` [PATCH v2 2/2] doc-rst: Programmatically render MAINTAINERS into ReST Kees Cook
2019-10-02 16:25 ` [PATCH v2 0/2] docs: " Jonathan Corbet
2019-10-02 16:57 ` Kees Cook
2019-10-02 17:24 ` 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=20191001182532.21538-1-keescook@chromium.org \
--to=keescook@chromium.org \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).