Skip to contentSkip to conversation

MAINTAINERS: include GOOGLE FIRMWARE entry

RFC PATCH In review Lukas Bulwahn 4 participants 10 messages Mar 8, 2020 – Mar 10, 2020 Kernel janitors

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 MAINTAINERS: include GOOGLE FIRMWARE entry

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

Add a basic entry for drivers/firmware/google/ based on a simple statistics on tags of commits in that directory:

  $ git log drivers/firmware/google/ | grep '\-by:' \
      | sort | uniq -c | sort -nr
     62     Signed-off-by: Greg Kroah-Hartman <[email protected]>
     13     Reviewed-by: Guenter Roeck <[email protected]>
     12     Signed-off-by: Stephen Boyd <[email protected]>
     11     Reviewed-by: Julius Werner <[email protected]>

There is no specific mailing list for this driver, based on observations on the patch emails, and the git history suggests the driver is maintained.

This was identified with a small script that finds all files belonging to THE REST according to the current MAINTAINERS file, and I investigated upon its output.

---
 MAINTAINERS | 8 ++++++++
 1 file changed, 8 insertions(+)
MAINTAINERS +8 -0
index 3a0f8115c92c..ed788804daab 100644
@@ -7111,6 +7111,14 @@ S:	Supported
 F:	Documentation/networking/device_drivers/google/gve.rst
 F:	drivers/net/ethernet/google
 
+GOOGLE FIRMWARE
+M:	Greg Kroah-Hartman <[email protected]>
+M:	Stephen Boyd <[email protected]>
+R:	Guenter Roeck <[email protected]>
+R:	Julius Werner <[email protected]>
+S:	Maintained
+F:	drivers/firmware/google/
+
 GPD POCKET FAN DRIVER
 M:	Hans de Goede <[email protected]>
 L:	[email protected]
Signature · 1 line
2.17.1
#1 lore raw
Quoted 30 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

Add a basic entry for drivers/firmware/google/ based on a simple statistics on tags of commits in that directory:

  $ git log drivers/firmware/google/ | grep '\-by:' \
      | sort | uniq -c | sort -nr
     62     Signed-off-by: Greg Kroah-Hartman <[email protected]>
     13     Reviewed-by: Guenter Roeck <[email protected]>
     12     Signed-off-by: Stephen Boyd <[email protected]>
     11     Reviewed-by: Julius Werner <[email protected]>

There is no specific mailing list for this driver, based on observations on the patch emails, and the git history suggests the driver is maintained.

This was identified with a small script that finds all files belonging to THE REST according to the current MAINTAINERS file, and I investigated upon its output.

---
 MAINTAINERS | 8 ++++++++
 1 file changed, 8 insertions(+)
MAINTAINERS +0 -0
index 3a0f8115c92c..ed788804daab 100644

MAINTAINERS S: Supported · line 7115

Quoted 5 lines
MAINTAINERS +2 -0
@@ -7111,6 +7111,14 @@ S:	Supported
 F:	Documentation/networking/device_drivers/google/gve.rst
 F:	drivers/net/ethernet/google
 
+GOOGLE FIRMWARE
+M:	Greg Kroah-Hartman <[email protected]>

No, sorry, I am not the maintainer of this. I'll be glad to be the person the maintainers send patches to to get into Linus's tree, but I am not going to be responsible for stuff I know nothing about :)

thanks,

greg k-h

#2 lore raw
In reply to Lukas Bulwahn
Quoted 13 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

Add a basic entry for drivers/firmware/google/ based on a simple statistics on tags of commits in that directory:

  $ git log drivers/firmware/google/ | grep '\-by:' \
      | sort | uniq -c | sort -nr
     62     Signed-off-by: Greg Kroah-Hartman <[email protected]>
     13     Reviewed-by: Guenter Roeck <[email protected]>
     12     Signed-off-by: Stephen Boyd <[email protected]>
     11     Reviewed-by: Julius Werner <[email protected]>
Quoted 2 lines

There is no specific mailing list for this driver, based on observations on the patch emails, and the git history suggests the driver is maintained.

The sign-off list is definitely not the MAINTAINER list as that sign-off list can identify the upstreaming path and not the actual maintainers.

You should instead try to identify the MAINTAINERS as authors of the various patches rather than the sign-off list.

And even then you need to isolate the trivial changes from the actual defect correction and significant features added.

And also time-limit the range of commits as people come and go and only relatively recent changes should be analyzed.

For instance:

$ git log --since=2-years-ago --no-merges --pretty="%aN <%aE>	%s" -- drivers/firmware/google
Gustavo A. R. Silva <[email protected]>    firmware: google: vpd: Replace zero-length array with flexible-array member
Gustavo A. R. Silva <[email protected]>    firmware: google: memconsole: Replace zero-length array with flexible-array member
Arthur Heymans <[email protected]>    firmware: google: Probe for a GSMI handler in firmware
Arthur Heymans <[email protected]>    firmware: google: Unregister driver_info on failure and exit in gsmi
Patrick Rudolph <[email protected]> firmware: google: Release devices before unregistering the bus
Brian Norris <[email protected]> firmware: google: increment VPD key_len properly
Hung-Te Lin <[email protected]>       firmware: google: check if size is valid when decoding VPD data
Thomas Gleixner <[email protected]>    treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 287
Stephen Boyd <[email protected]>      firmware: google: coreboot: Drop unnecessary headers
Stephen Boyd <[email protected]>      firmware: google: memconsole: Drop global func pointer
Stephen Boyd <[email protected]>      firmware: google: memconsole: Drop __iomem on memremap memory
Stephen Boyd <[email protected]>      firmware: google: memconsole: Use devm_memremap()
Stephen Boyd <[email protected]>      firmware: google: Add a module_coreboot_driver() macro and use it
Thomas Gleixner <[email protected]>    treewide: Add SPDX license identifier - Makefile/Kconfig
Thomas Gleixner <[email protected]>    treewide: Add SPDX license identifier for more missed files
Stephen Boyd <[email protected]>      firmware: vpd: Drop __iomem usage for memremap() memory
Furquan Shaikh <[email protected]>   gsmi: Add GSMI commands to log S0ix info
Duncan Laurie <[email protected]>    gsmi: Remove autoselected dependency on EFI and EFI_VARS
Duncan Laurie <[email protected]>    gsmi: Add coreboot to list of matching BIOS vendors
Duncan Laurie <[email protected]>    gsmi: Fix bug in append_to_eventlog sysfs handler
Colin Ian King <[email protected]>       firmware: vpd: fix spelling mistake "partion" -> "partition"
Stephen Boyd <[email protected]>      firmware: coreboot: Only populate devices in coreboot_table_init()
Stephen Boyd <[email protected]>      firmware: coreboot: Remap RAM with memremap() instead of ioremap()
Stephen Boyd <[email protected]>      firmware: coreboot: Collapse platform drivers into bus core
Stephen Boyd <[email protected]>      firmware: coreboot: Make bus registration symmetric
Stephen Boyd <[email protected]>      firmware: coreboot: Unmap ioregion after device population
Stephen Boyd <[email protected]>      firmware: coreboot: Let OF core populate platform device
Colin Ian King <[email protected]>       firmware: google: make structure gsmi_dev static
Anton Vasilyev <[email protected]>     firmware: vpd: Fix section enabled flag on vpd_section_destroy
Samuel Holland <[email protected]>    firmware: coreboot: Add coreboot framebuffer driver
Samuel Holland <[email protected]>    firmware: coreboot: Remove unused coreboot_table_find
Samuel Holland <[email protected]>    firmware: vpd: Probe via coreboot bus
Samuel Holland <[email protected]>    firmware: memconsole: Probe via coreboot bus
Samuel Holland <[email protected]>    firmware: coreboot: Expose the coreboot table as a bus

Thomas Gleixner did licensing changes treewide which would have no maintainer role, Gustavo Silva did generic style changes and Stephen Boyd is really the only party here that has done fundamental changes.

It's not an easy problem, but adding

#3 lore raw
In reply to Lukas Bulwahn
Quoted 32 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

Add a basic entry for drivers/firmware/google/ based on a simple statistics on tags of commits in that directory:

  $ git log drivers/firmware/google/ | grep '\-by:' \
      | sort | uniq -c | sort -nr
     62     Signed-off-by: Greg Kroah-Hartman <[email protected]>
     13     Reviewed-by: Guenter Roeck <[email protected]>
     12     Signed-off-by: Stephen Boyd <[email protected]>
     11     Reviewed-by: Julius Werner <[email protected]>

There is no specific mailing list for this driver, based on observations on the patch emails, and the git history suggests the driver is maintained.

This was identified with a small script that finds all files belonging to THE REST according to the current MAINTAINERS file, and I investigated upon its output.

---
 MAINTAINERS | 8 ++++++++
 1 file changed, 8 insertions(+)
MAINTAINERS +0 -0
index 3a0f8115c92c..ed788804daab 100644
@@ -7111,6 +7111,14 @@ S:       Supported
 F:     Documentation/networking/device_drivers/google/gve.rst

MAINTAINERS S: Supported · line 7121

Quoted 10 lines
MAINTAINERS +8 -0
 F:     drivers/net/ethernet/google
 
+GOOGLE FIRMWARE
+M:     Greg Kroah-Hartman <[email protected]>
+M:     Stephen Boyd <[email protected]>
+R:     Guenter Roeck <[email protected]>
+R:     Julius Werner <[email protected]>
+S:     Maintained
+F:     drivers/firmware/google/
+

FWIW, I would not mind stepping up as maintainer if needed, but I think we should strongly discourage this kind of auto-assignment of maintainers and/or reviewers.

Guenter

Quoted 6 lines
MAINTAINERS +0 -1
 GPD POCKET FAN DRIVER
 M:     Hans de Goede <[email protected]>
 L:     [email protected]
--

2.17.1

#4 lore raw
Quoted 3 lines · Guenter Roeck
Quoted 2 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

[]

Quoted 1 line

MAINTAINERS

Quoted 1 line
MAINTAINERS +0 -0

[]

Quoted 4 lines
Quoted 4 lines
MAINTAINERS +0 -0
@@ -7111,6 +7111,14 @@ S:       Supported
 F:     Documentation/networking/device_drivers/google/gve.rst
 F:     drivers/net/ethernet/google
 
Quoted 12 lines

MAINTAINERS S: Supported · line 7121

Quoted 8 lines
MAINTAINERS +8 -0
+GOOGLE FIRMWARE
+M:     Greg Kroah-Hartman <[email protected]>
+M:     Stephen Boyd <[email protected]>
+R:     Guenter Roeck <[email protected]>
+R:     Julius Werner <[email protected]>
+S:     Maintained
+F:     drivers/firmware/google/
+

FWIW, I would not mind stepping up as maintainer if needed, but I think we should strongly discourage this kind of auto-assignment of maintainers and/or reviewers.

Auto assignment should definitely _not_ be done.

This is an RFC proposal though.

Sometimes it's better to not produce an RFC as a patch, but maybe just show a proposed section and ask if is appropriate may be a better style going forward.

Maybe just emailing Greg, Stephen, Guenter and Julius (cc'ing LKML) asking something like the below would be better:

----------------------------------------------------

Hey all.

Files in drivers/firmware/google/ do not seem to have a listed MAINTAINER.

Would a section entry in MAINTAINERS like this be appropriate?

GOOGLE FIRMWARE

M:     Greg Kroah-Hartman <[email protected]>
M:     Stephen Boyd <[email protected]>
R:     Guenter Roeck <[email protected]>
R:     Julius Werner <[email protected]>
S:     Maintained
F:     drivers/firmware/google/

Is there a git tree somewhere that should be added? What would be the
status of this proposed section?
Does someone really look after it at
all?

#5 lore raw
Quoted 24 lines · Joe Perches
Quoted 3 lines · Guenter Roeck
Quoted 2 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

[]

Quoted 1 line

MAINTAINERS

Quoted 1 line
MAINTAINERS +0 -0

[]

Quoted 4 lines
Quoted 4 lines
MAINTAINERS +0 -0
@@ -7111,6 +7111,14 @@ S:       Supported
 F:     Documentation/networking/device_drivers/google/gve.rst
 F:     drivers/net/ethernet/google
 
Quoted 12 lines

MAINTAINERS S: Supported · line 7121

Quoted 8 lines
MAINTAINERS +8 -0
+GOOGLE FIRMWARE
+M:     Greg Kroah-Hartman <[email protected]>
+M:     Stephen Boyd <[email protected]>
+R:     Guenter Roeck <[email protected]>
+R:     Julius Werner <[email protected]>
+S:     Maintained
+F:     drivers/firmware/google/
+

FWIW, I would not mind stepping up as maintainer if needed, but I think we should strongly discourage this kind of auto-assignment of maintainers and/or reviewers.

Quoted 9 lines

Auto assignment should definitely _not_ be done.

This is an RFC proposal though.

Sometimes it's better to not produce an RFC as a patch, but maybe just show a proposed section and ask if is appropriate may be a better style going forward.

Please interpret the RFC patch similar to an email as Joe wrote below, simply reaching out to you.

There is no auto-assignment intended, nor did I expect the patch to be picked up on the first attempt of uneducated guessing.

There are currently around 3,000 files identified being part of THE REST; so they are all assigned to Linus and LKML.

To confirm that they actually are maintained by someone else and reflect that in MAINTAINERS, a bit of educated guessing who to contact and to which entry to add the files to is required.

I am starting with the "bigger" clustered files in drivers, and then try to look at files in include and Documentation/ABI/.

Here is a rough statistics on how many files from each directory are in THE REST:

1368 include

    566 tools
    327 lib
    321 Documentation
    100 drivers
     91 kernel
     84 scripts
     75 samples
     13 ipc
     13 init
      8 usr
      2 arch
      1 virt
Quoted 22 lines

Maybe just emailing Greg, Stephen, Guenter and Julius (cc'ing LKML) asking something like the below would be better:

----------------------------------------------------

Hey all.

Files in drivers/firmware/google/ do not seem to have a listed MAINTAINER.

Would a section entry in MAINTAINERS like this be appropriate?

GOOGLE FIRMWARE

M:     Greg Kroah-Hartman <[email protected]>
M:     Stephen Boyd <[email protected]>
R:     Guenter Roeck <[email protected]>
R:     Julius Werner <[email protected]>
S:     Maintained
F:     drivers/firmware/google/
Quoted 6 lines

Is there a git tree somewhere that should be added? What would be the
status of this proposed section?
Does someone really look after it at
all?

Thanks for the proposal; I was not sure about the best way to reach out to others on suggesting to add new entries.

In the future, I will simply send out emails, as those above, when suggesting to add new entries.

Thanks for the feedback and sorry for the churn. Once most files are assigned, it is much easier to follow when someone missed to adjust the MAINTAINERS file and send out a friendly hint. I hope that is worth the initial churn for some people at the beginning of this clean-up.

Lukas

#6 lore raw
Quoted 57 lines · Lukas Bulwahn
Quoted 24 lines · Joe Perches
Quoted 3 lines · Guenter Roeck
Quoted 2 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

[]

Quoted 1 line

MAINTAINERS

Quoted 1 line
MAINTAINERS +0 -0

[]

Quoted 4 lines
Quoted 4 lines
MAINTAINERS +0 -0
@@ -7111,6 +7111,14 @@ S:       Supported
 F:     Documentation/networking/device_drivers/google/gve.rst
 F:     drivers/net/ethernet/google
 
Quoted 12 lines

MAINTAINERS S: Supported · line 7121

Quoted 8 lines
MAINTAINERS +8 -0
+GOOGLE FIRMWARE
+M:     Greg Kroah-Hartman <[email protected]>
+M:     Stephen Boyd <[email protected]>
+R:     Guenter Roeck <[email protected]>
+R:     Julius Werner <[email protected]>
+S:     Maintained
+F:     drivers/firmware/google/
+

FWIW, I would not mind stepping up as maintainer if needed, but I think we should strongly discourage this kind of auto-assignment of maintainers and/or reviewers.

Quoted 9 lines

Auto assignment should definitely _not_ be done.

This is an RFC proposal though.

Sometimes it's better to not produce an RFC as
a patch, but maybe just show a proposed section
and ask if is appropriate may be a better style
going forward.

Please interpret the RFC patch similar to an email as Joe wrote below, simply reaching out to you.

There is no auto-assignment intended, nor did I expect the patch to be picked up on the first attempt of uneducated guessing.

There are currently around 3,000 files identified being part of THE REST; so they are all assigned to Linus and LKML.

To confirm that they actually are maintained by someone else and reflect that in MAINTAINERS, a bit of educated guessing who to contact and to which entry to add the files to is required.

I am starting with the "bigger" clustered files in drivers, and then try to look at files in include and Documentation/ABI/.

Here is a rough statistics on how many files from each directory are in THE REST:

Quoted 13 lines
   1368 include
    566 tools
    327 lib
    321 Documentation
    100 drivers
     91 kernel
     84 scripts
     75 samples
     13 ipc
     13 init
      8 usr
      2 arch
      1 virt

When you use the get_maintainer.pl script, it should find reasonable people/lists for those files, so why not just stick with that? Trying to classify all of the kernel files to have MAINTAINERS entries seems like a loosing proposition as there are file that no one has touched in years.

thanks,

greg k-h

#7 lore raw
Quoted 72 lines · Greg Kroah-Hartman
Quoted 57 lines · Lukas Bulwahn
Quoted 24 lines · Joe Perches
Quoted 3 lines · Guenter Roeck
Quoted 2 lines · Lukas Bulwahn

All files in drivers/firmware/google/ are identified as part of THE REST according to MAINTAINERS, but they are really maintained by others.

[]

Quoted 1 line

MAINTAINERS

Quoted 1 line
MAINTAINERS +0 -0

[]

Quoted 4 lines
Quoted 4 lines
MAINTAINERS +0 -0
@@ -7111,6 +7111,14 @@ S:       Supported
 F:     Documentation/networking/device_drivers/google/gve.rst
 F:     drivers/net/ethernet/google
 
Quoted 12 lines

MAINTAINERS S: Supported · line 7121

Quoted 8 lines
MAINTAINERS +8 -0
+GOOGLE FIRMWARE
+M:     Greg Kroah-Hartman <[email protected]>
+M:     Stephen Boyd <[email protected]>
+R:     Guenter Roeck <[email protected]>
+R:     Julius Werner <[email protected]>
+S:     Maintained
+F:     drivers/firmware/google/
+

FWIW, I would not mind stepping up as maintainer if needed, but I think we should strongly discourage this kind of auto-assignment of maintainers and/or reviewers.

Quoted 9 lines

Auto assignment should definitely _not_ be done.

This is an RFC proposal though.

Sometimes it's better to not produce an RFC as
a patch, but maybe just show a proposed section
and ask if is appropriate may be a better style
going forward.

Please interpret the RFC patch similar to an email as Joe wrote below, simply reaching out to you.

There is no auto-assignment intended, nor did I expect the patch to be picked up on the first attempt of uneducated guessing.

There are currently around 3,000 files identified being part of THE REST; so they are all assigned to Linus and LKML.

To confirm that they actually are maintained by someone else and reflect that in MAINTAINERS, a bit of educated guessing who to contact and to which entry to add the files to is required.

I am starting with the "bigger" clustered files in drivers, and then try to look at files in include and Documentation/ABI/.

Here is a rough statistics on how many files from each directory are in THE REST:

Quoted 13 lines
   1368 include
    566 tools
    327 lib
    321 Documentation
    100 drivers
     91 kernel
     84 scripts
     75 samples
     13 ipc
     13 init
      8 usr
      2 arch
      1 virt
Quoted 5 lines

When you use the get_maintainer.pl script, it should find reasonable people/lists for those files, so why not just stick with that? Trying to classify all of the kernel files to have MAINTAINERS entries seems like a loosing proposition as there are file that no one has touched in years.

I would at least hope that there are some quick wins with some cases that are pretty obvious to be added to existing entries. A first scan suggested that it should not take too much detective work to figure it out for some of those files.

For files that have not been touched in years---which I hope are not the majority of the cases---it would be nice to see if I can find out that these files are part of a entry/subsystem that actually maintains them, but did not need to touch them in years, or if these files are orphaned (or even meaningless left-overs) but nobody noticed because it was never made explicit in the MAINTAINERS file.

After those quick wins, getting this done for ALL files could turn out to be impossible, and just checking for future changes and reacting to those is the better approach to ensure that new files have an entry in MAINTAINERS, but I guess I will find out how much is quickly and easily allocated to a MAINTAINERS entry and what cannot be determined as outsider and relying on get_maintainer.pl is more reliable than getting a confirmation for a dedicated entry in MAINTAINERS.

If the feedback is consistently discouraging to update existing entries with additions for currently non-assigned files, I will stop figuring out the changes and relying on get_maintainers.pl without making use of any data from the MAINTAINERS file for those cases remains the best option, just as it is today.

I am willing to investigate if this point can be improved in the MAINTAINERS file. If it is all good, as it is right now, or it simply cannot be improved without a lot of attention from many developers, everything can stay as-is and I will look into other topics.

Lukas

#8 lore raw
Quoted 2 lines · Lukas Bulwahn

I am starting with the "bigger" clustered files in drivers, and then try

Quoted 1 line
Quoted 1 line

to look at files in include and Documentation/ABI/.

If you want to spend the time tracking stuff down, it may be best to to
start with include/

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

Here is a rough statistics on how many files from each directory are in THE REST:

   1368 include

There are very likely some files there that should actually be listed as part of a subsystem.

Quoted 1 line
Quoted 1 line
Quoted 1 line
    327 lib

Not many that aren't trivial or ancient.

Quoted 1 line
Quoted 1 line
Quoted 1 line

321 Documentation

Probably a few

Quoted 1 line
Quoted 1 line
Quoted 1 line
    100 drivers

What's not already maintained is probably ancient.

Everything else may not matter much.

#9 lore raw
Quoted 8 lines · Joe Perches
Quoted 2 lines · Lukas Bulwahn

I am starting with the "bigger" clustered files in drivers, and then try

Quoted 1 line
Quoted 1 line

to look at files in include and Documentation/ABI/.

If you want to spend the time tracking stuff down, it may be best to to
start with include/

Thanks for the guidance. I will do that, and we will see if others appreciate that or not.

Lukas