[PATCH v3 00/13] Improve process/maintainers output

Mauro Carvalho Chehab posted 13 patches 1 month ago
Documentation/sphinx/maintainers_include.py | 478 ++++++++++++--------
MAINTAINERS                                 |   8 +-
2 files changed, 294 insertions(+), 192 deletions(-)
[PATCH v3 00/13] Improve process/maintainers output
Posted by Mauro Carvalho Chehab 1 month ago
Hi Jon,

This series improve the output at process/maintainers: instead of a
pure enriched text, the maintainer's file content is now converted
to a table, and has gained a javascript to allow filtering entries.

The initial patches change the logic to split parsing from
output generation. Then, everything is stored into a dict at
the parsing phase, and ona header description variable.

This way, it is easier to adjust the output handler to produce
a more structured document. Right now, the entries are sorted
alphabetically, per subsystem's name(*).

(*) Currently, MAINTAINERS file has several entries not sorted.
    One has to run:

	 scripts/parse-maintainers.pl --input MAINTAINERS --output MAINTAINERS.new

    to sort it.

-

v3:
  - don't remove rust/pin-init/CONTRIBUTING.md;
  - added two extra patches due to sashiko-bot feedback, to better
    handle wildcards and paths;
  - fixed some issues related with O=DIRS;

v2:
  - now, entries are sorted internally, instead of trusting that
    MAINTAINERS is already sorted;
  - file fields inside the description are now showing as literals;
  - Added a change in MAINTAINERS for rust-init profile;
  - Make it clearer at MAINTAINERS description that "P" expects
    a rst file;
  - fixed several bugs related to using or not O=DOCS.



Mauro Carvalho Chehab (13):
  docs: maintainers_include: keep hidden TOC sorted
  docs: maintainers_include: split state machine on multiple funcs
  docs: maintainers_include: cleanup the code
  docs: maintainers_include: clean most SPHINXDIRS=process warnings
  docs: maintainers_include: do some coding style cleanups
  docs: maintainers_include: store maintainers entries on a dict
  docs: maintainers_include: properly handle file patterns
  docs: maintainers_include: add a filtering javascript
  docs: maintainers_include: don't ignore invalid profile entries
  docs: maintainers_include: better handle directories
  docs: maintainers_include: better handle doc wildcards
  MAINTAINERS: make clearer about what's expected for "P" field
  MAINTAINERS: use a URL for pin-init maintainer's profile entry

 Documentation/sphinx/maintainers_include.py | 478 ++++++++++++--------
 MAINTAINERS                                 |   8 +-
 2 files changed, 294 insertions(+), 192 deletions(-)

-- 
2.54.0
Re: [PATCH v3 00/13] Improve process/maintainers output
Posted by Jonathan Corbet 4 weeks ago
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> Hi Jon,
>
> This series improve the output at process/maintainers: instead of a
> pure enriched text, the maintainer's file content is now converted
> to a table, and has gained a javascript to allow filtering entries.

OK, I've applied it.  I've wondered about including the MAINTAINERS
stuff, but I must admit that the search box is kind of cool...

jon
Re: [PATCH v3 00/13] Improve process/maintainers output
Posted by Mauro Carvalho Chehab 3 weeks, 6 days ago
On Fri, 15 May 2026 08:07:59 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > Hi Jon,
> >
> > This series improve the output at process/maintainers: instead of a
> > pure enriched text, the maintainer's file content is now converted
> > to a table, and has gained a javascript to allow filtering entries.  
> 
> OK, I've applied it.  

Thanks!

> I've wondered about including the MAINTAINERS
> stuff, but I must admit that the search box is kind of cool...

IMO, with the search box, this is now a lot more usable, and should
likely be helpful to the readers.

Thanks,
Mauro
Re: [PATCH v3 00/13] Improve process/maintainers output
Posted by Joe Perches 1 month ago
On Sat, 2026-05-09 at 08:56 +0200, Mauro Carvalho Chehab wrote:
> This series improve the output at process/maintainers: instead of a
> pure enriched text, the maintainer's file content is now converted
> to a table, and has gained a javascript to allow filtering entries.
[]
> (*) Currently, MAINTAINERS file has several entries not sorted.
>     One has to run:
> 
> 	 scripts/parse-maintainers.pl --input MAINTAINERS --output MAINTAINERS.new

Maybe add --order