[PATCH v2 00/11] Improve process/maintainers output

Mauro Carvalho Chehab posted 11 patches 1 month, 1 week ago
There is a newer version of this series
Documentation/sphinx/maintainers_include.py | 414 ++++++++++++--------
MAINTAINERS                                 |   4 +-
rust/pin-init/CONTRIBUTING.md               |  72 ----
3 files changed, 256 insertions(+), 234 deletions(-)
delete mode 100644 rust/pin-init/CONTRIBUTING.md
[PATCH v2 00/11] Improve process/maintainers output
Posted by Mauro Carvalho Chehab 1 month, 1 week 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.

-

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 (11):
  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
  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 | 414 ++++++++++++--------
 MAINTAINERS                                 |   4 +-
 rust/pin-init/CONTRIBUTING.md               |  72 ----
 3 files changed, 256 insertions(+), 234 deletions(-)
 delete mode 100644 rust/pin-init/CONTRIBUTING.md

-- 
2.54.0