linux/Documentation/process
Kees Cook aa20485528 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:
  https://www.kernel.org/doc/html/latest/process/maintainers.html#secure-computing

- 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.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 <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-10-02 10:03:17 -06:00
..
1.Intro.rst doc:it_IT: add some process/* translations 2018-11-20 09:11:12 -07:00
2.Process.rst docs: fix typo in table describing 4.16 development cycle 2018-08-31 16:28:06 -06:00
3.Early-stage.rst Documentation/process: phrasofix 2017-09-26 14:53:51 -06:00
4.Coding.rst docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
5.Posting.rst docs: Clarify the usage and sign-off requirements for Co-developed-by 2019-03-25 10:30:32 -06:00
6.Followthrough.rst
7.AdvancedTopics.rst
8.Conclusion.rst doc:process: add links where missing 2018-12-06 10:21:19 -07:00
adding-syscalls.rst doc:it_IT: add some process/* translations 2018-11-20 09:11:12 -07:00
applying-patches.rst Documentation: change linux-4.x references to 5.x 2019-02-17 15:41:05 -07:00
changes.rst Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next 2019-07-11 10:55:49 -07:00
clang-format.rst clang-format: add configuration file 2018-04-11 10:28:35 -07:00
code-of-conduct-interpretation.rst Code of Conduct Interpretation: Put in the proper URL for the committee 2018-10-22 07:33:36 +01:00
code-of-conduct.rst Code of Conduct: Change the contact email address 2018-10-22 07:33:36 +01:00
coding-style.rst docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
deprecated.rst Makefile: Globally enable fall-through warning 2019-07-25 20:13:54 -05:00
development-process.rst
email-clients.rst doc: email-clients miscellaneous fixes 2019-07-31 13:05:37 -06:00
embargoed-hardware-issues.rst Documentation/process: Clarify disclosure rules 2019-09-29 12:43:18 +02:00
howto.rst docs: process: fix broken link 2019-08-24 15:14:38 -06:00
index.rst doc-rst: Programmatically render MAINTAINERS into ReST 2019-10-02 10:03:17 -06:00
kernel-docs.rst Documentation: kernel-docs: Remove entry for vfs.txt 2019-04-08 16:05:18 -06:00
kernel-driver-statement.rst doc:it_IT: add some process/* translations 2018-11-20 09:11:12 -07:00
kernel-enforcement-statement.rst doc:it_IT: add some process/* translations 2018-11-20 09:11:12 -07:00
license-rules.rst LICENSES: Rename other to deprecated 2019-05-03 06:34:32 -06:00
magic-number.rst doc:it_IT: add some process/* translations 2018-11-20 09:11:12 -07:00
maintainer-pgp-guide.rst Documentation: PGP: update for newer HW devices 2019-06-26 16:08:03 -06:00
maintainers.rst doc-rst: Programmatically render MAINTAINERS into ReST 2019-10-02 10:03:17 -06:00
management-style.rst doc:process: add links where missing 2018-12-06 10:21:19 -07:00
programming-language.rst Compiler Attributes: add Doc/process/programming-language.rst 2018-09-30 20:14:04 +02:00
stable-api-nonsense.rst doc: process: GPL -> GPL-compatible 2019-02-01 16:19:11 -07:00
stable-kernel-rules.rst stable-kernel-rules.rst: add link to networking patch queue 2019-02-01 16:11:55 -07:00
submit-checklist.rst docs: ioctl-number.txt: convert it to ReST format 2019-07-15 09:20:26 -03:00
submitting-drivers.rst docs: power: convert docs to ReST and rename to *.rst 2019-06-14 16:08:36 -05:00
submitting-patches.rst docs: process: fix broken link 2019-08-24 15:14:38 -06:00
volatile-considered-harmful.rst Documentation/atomic_ops.txt: convert to ReST markup 2016-11-30 17:40:52 -07:00