path: root/Documentation/
diff options
authorKees Cook <>2019-10-01 11:25:32 -0700
committerJonathan Corbet <>2019-10-02 10:03:17 -0600
commitaa204855281389fe25c0049190531ba67e043d99 (patch)
treeca2ae79fb7353838ceebac98b36a7aaea780b194 /Documentation/
parent1b1438b5351f54d3fb8b3cc1579dea7668b03ca0 (diff)
doc-rst: Programmatically render MAINTAINERS into ReST
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: - 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 <> Reviewer: Andy Lutomirski <>, Will Drewry <> SCM: git git:// 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 Signed-off-by: Kees Cook <> Signed-off-by: Jonathan Corbet <>
Diffstat (limited to 'Documentation/')
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/ b/Documentation/
index a8fe845832bc..3c7bdf4cd31f 100644
--- a/Documentation/
+++ b/Documentation/
@@ -37,7 +37,8 @@ needs_sphinx = '1.3'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
- 'kfigure', 'sphinx.ext.ifconfig', 'automarkup']
+ 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
+ 'maintainers_include']
# The name of the math extension changed on Sphinx 1.4
if (major == 1 and minor > 3) or (major > 1):