In most of MAINTAINERS.txt, - denotes the beginning of a line with a component maintainer on it. However, the sub-components under the database system begin with - as well. The hierarchy is still clear from the indentation so we can strip this off to make the file more parseable.

CommentFileSizeAuthor
#8 parseable-maintainers-2102141-8.patch1.08 KBxjm
#8 db_interdiff.txt708 bytesxjm
friendly_for_parsing.patch1.07 KBxjm

Comments

xjm’s picture

xjm
she/her
Primary language English
commented

It'd also help to make the component names match the d.o component list entries more closely. Module names are easily transformed into the format in the dropdown, but subsystems not so much.

xjm’s picture

xjm
she/her
Primary language English
commented

So:

  • In MAINTAINERS.txt, the databases are listed as (e.g.) "PostgreSQL driver", but in the dropdown, it's "postgresql database".
  • MAINTAINERS.txt uses the user-facing label for each module (or sometimes something else human-readable; it's Simpletest module rather than Testing module), but the component dropdown uses the machine name. This causes some fun when they differ, e.g. hal.module. We could probably add machine names in brackets or something.

Also, here's the script @alexpott wrote to parse the file:
https://gist.github.com/xjm/837b83c584a0c1e21c5c

Crell’s picture

Crell commented

Technically we don't provide a MySQL or Postgres database. We don't support Postgres, we support a Drupal DB driver FOR Postgres. So I think standardizing on "postgresql driver" not "postgresql database" is more appropriate.

I have no opinion on the subsystem indentation stuff.

xjm’s picture

xjm
she/her
Primary language English
commented

How about "PostgreSQL database driver"?

Crell’s picture

Crell commented

A bit long for the component select widget. :-)

xjm’s picture

xjm
she/her
Primary language English
commented

Not any longer than context_translation.module so I think it's okay. :)

Crell’s picture

Crell commented

If it doesn't break the select box I guess it's OK. :-P Maybe abbreviate database? "PostgreSQL DB driver"?

(Yes, this is total bikeshed at this point.)

xjm’s picture

xjm
she/her
Primary language English
commented
StatusFileSize
new db_interdiff.txt708 bytes
new parseable-maintainers-2102141-8.patch1.08 KB

Shed: painted.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

This patch looks totally reasonable to take care of the problem noted in the original issue posting, but it doesn't take care of comment #1. Do you still want to do #1?

Crell’s picture

Crell commented
Status: Needs review » Reviewed & tested by the community

As of when I type this, it looks like the Component list has been updated to match the strings in #8 as well. Thus...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

The list of components in MAINTAINERS does not match the list of components in the Component drop-down list -- at least, there are components in MAINTAINERS not in the drop-down. And there are a few other differences, like "forms system" vs. "form system".

So I do not believe the goal of #1 is achieved with this patch.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented
Component: documentation » forms system
Status: Needs work » Reviewed & tested by the community

Then the component drop down is wrong. That's a separate issue, and not related to these changes to the database system.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
commented
Component: forms system » documentation

LOL, speaking of the incorrectly named "forms system"...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Do we have a separate issue for cleaning up the other components then?

Or should we just use this issue, since it isn't too long yet? If someone wants to go through MAINTAINERS and make a list of differences between what we see there and the components in the issue queue, that would be hefpful. Some of them may make more sense to edit in MAINTAINERS, and some may make more sense to edit the component.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Active

Meanwhile, I committed the patch above in #8. Leaving active for #14, or someone can start a separate issue if desired.

xjm’s picture

xjm
she/her
Primary language English
commented
Title: Make MAINTAINERS.txt friendlier for parsing » Make MAINTAINERS.txt database section friendlier for parsing
Issue summary: View changes
Status: Active » Closed (fixed)

Most of the outstanding scope of this is covered by #2457875: [policy] Evolving and documenting Drupal core's structure, responsibilities, and decision-making and its inevitable many followups, so setting back to fixed for the original patch, and retitling to the actual scope of that patch.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue tags: -Component maintainers