Skip to content

RFC Auto-generate maintainer profile entries

Mauro Carvalho Chehab linux-doc linux-riscv lkml workflows 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest4 patches 6 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4docs: maintainers_include: auto-generate maintainer profile TOCDocumentation/sphinx/maintainers_include.py+76 -171 reply
2/4MAINTAINERS: add an entry for media maintainers profileMAINTAINERS+1 -01 reply
3/4MAINTAINERS: add maintainer-tip.rst to X86MAINTAINERS+1 -02 replies
4/4docs: auto-generate maintainer entry profile linksDocumentation/maintainer/maintainer-entry-profile.rst Documentation/process/maintainer-handbooks.rst+3 -242 replies

Reviews trailers per patch

3 of 4 patches have a Reviewed-by or Acked-by.

PatchRandy DunlapDan Williams
1/4A-b
2/4A-b
3/4A-b A-b
4/4

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH RFC 0/4] Auto-generate maintainer profile entries

Hi Dan/Jon,

This small patch series change the way maintainer entry profile links are added to the documentation. Instead of having an entry for each of them at an ReST file, get them from MAINTAINERS content.

That should likely make easier to maintain, as there will be a single point to place all such profiles.

I made this as an RFC. The goal is mostly to be a start of discussions about how this is implemented.

Also, it should be noticed that I'm not incorporating the diff content from Dan's sugggestion, as it was just an e-mail reply without a proper patch title/description/SoB.

Some points on this RFC:

1. some P: entries are links to web pages. The current approach ignores them;

2. the current logic doesn't use glob. So, if one would add an entry like:

P: Documentation/foo/profiles-*.rst

it will generate an entry like "../foo/profiles-*".

This probably works, as toc trees accept glob.

3. entries are placed at the order they occur at MAINTAINERS file (but duplication is properly handled);

4. as Randy mentioned, if an entry there is inside another TOC using numeration, those entries will have numeration as well;

5. the approach I took on patch 1 was a little bit lazy, as it ends processing MAINTAINERS two times, and there are some code duplication on different classes to handle path. I opted to do this way to minimize the differences, but it makes sense to clean the code later on newer versions of this series or after applying it;

6. patches 2 and 3 can be applied independently of this approach. They just add two missing "P:" entries to MAINTAINERS.

Mauro Carvalho Chehab (4):
docs: maintainers_include: auto-generate maintainer profile TOC
MAINTAINERS: add an entry for media maintainers profile
MAINTAINERS: add maintainer-tip.rst to X86
docs: auto-generate maintainer entry profile links

 .../maintainer/maintainer-entry-profile.rst   | 17 +---
 .../process/maintainer-handbooks.rst          | 10 +-
 Documentation/sphinx/maintainers_include.py   | 93 +++++++++++++++----
 MAINTAINERS                                   |  2 +
 4 files changed, 81 insertions(+), 41 deletions(-)
Signature · 1 line
2.52.0