]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: maintainers_include: improve its output
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 27 Apr 2026 14:22:26 +0000 (16:22 +0200)
committerJonathan Corbet <corbet@lwn.net>
Sun, 3 May 2026 15:24:30 +0000 (09:24 -0600)
commit237abdfaa696b59b8fe750c915ec7d0f5233df90
treec0b14d04cc26e7758bfbad047718e1cb4ccb56d9
parentbda185c3059332ed9d64209858292233b71df7e3
docs: maintainers_include: improve its output

There are three "types" of profiles:
1. Profiles already included inside subsystem-specific documentation.
   This is the most common case;
2. Profiles that are hosted externally;
3. Profiles that are at the same location as maintainer-handbooks.rst.

For (3), we need to create a TOC, as they don't exist elsewhere.

Change the logic to create TOC just for (3), prepending the
content of maintainer-handbooks with a sorted entry of all types,
before the TOC.

With such change, we can have an unique sorted list of profiles,
having the subsystem names used there listed.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <10d06a3f530e07ad981aba93617a9a7f4d63c408.1777295258.git.mchehab+huawei@kernel.org>
Documentation/sphinx/maintainers_include.py