diff mbox series

[net,v2,3/5] MAINTAINERS: Add limited globs for Networking headers

Message ID 20240821-net-mnt-v2-3-59a5af38e69d@kernel.org (mailing list archive)
State Accepted
Commit 8cb0a938d90b25f123fcb2e24bbda9eaabd79c9e
Delegated to: Netdev Maintainers
Headers show
Series MAINTAINERS: Networking updates | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net, async
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success No Fixes tags, but series doesn't touch code
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 7 this patch: 7
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 0 of 0 maintainers
netdev/build_clang success Errors and warnings before: 7 this patch: 7
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 7 this patch: 7
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 28 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-08-22--03-00 (tests: 711)

Commit Message

Simon Horman Aug. 21, 2024, 8:46 a.m. UTC
This aims to add limited globs to improve the coverage of header files
in the NETWORKING DRIVERS and NETWORKING [GENERAL] sections.

It is done so in a minimal way to exclude overlap with other sections.
And so as not to require "X" entries to exclude files otherwise
matched by these new globs.

While imperfect, due to it's limited nature, this does extend coverage
of header files by these sections. And aims to automatically cover
new files that seem very likely belong to these sections.

The include/linux/netdev* glob (both sections)
+ Subsumes the entries for:
  - include/linux/netdevice.h
+ Extends the sections to cover
  - include/linux/netdevice_xmit.h
  - include/linux/netdev_features.h

The include/uapi/linux/netdev* globs: (both sections)
+ Subsumes the entries for:
  - include/linux/netdevice.h
+ Extends the sections to cover
  - include/linux/netdev.h

The include/linux/skbuff* glob (NETWORKING [GENERAL] section only):
+ Subsumes the entry for:
  - include/linux/skbuff.h
+ Extends the section to cover
  - include/linux/skbuff_ref.h

A include/uapi/linux/net_* glob was not added to the NETWORKING [GENERAL]
section. Although it would subsume the entry for
include/uapi/linux/net_namespace.h, which is fine, it would also extend
coverage to:
- include/uapi/linux/net_dropmon.h, which belongs to the
   NETWORK DROP MONITOR section
- include/uapi/linux/net_tstamp.h which, as per an earlier patch in this
  series, belongs to the SOCKET TIMESTAMPING section

Signed-off-by: Simon Horman <horms@kernel.org>
---
v2:
* New patch
---
 MAINTAINERS | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Paolo Abeni Aug. 22, 2024, 1:37 p.m. UTC | #1
On 8/21/24 10:46, Simon Horman wrote:
> This aims to add limited globs to improve the coverage of header files
> in the NETWORKING DRIVERS and NETWORKING [GENERAL] sections.
> 
> It is done so in a minimal way to exclude overlap with other sections.
> And so as not to require "X" entries to exclude files otherwise
> matched by these new globs.
> 
> While imperfect, due to it's limited nature, this does extend coverage
> of header files by these sections. And aims to automatically cover
> new files that seem very likely belong to these sections.
> 
> The include/linux/netdev* glob (both sections)
> + Subsumes the entries for:
>    - include/linux/netdevice.h
> + Extends the sections to cover
>    - include/linux/netdevice_xmit.h
>    - include/linux/netdev_features.h
> 
> The include/uapi/linux/netdev* globs: (both sections)
> + Subsumes the entries for:
>    - include/linux/netdevice.h
> + Extends the sections to cover
>    - include/linux/netdev.h
> 
> The include/linux/skbuff* glob (NETWORKING [GENERAL] section only):
> + Subsumes the entry for:
>    - include/linux/skbuff.h
> + Extends the section to cover
>    - include/linux/skbuff_ref.h
> 
> A include/uapi/linux/net_* glob was not added to the NETWORKING [GENERAL]
> section. Although it would subsume the entry for
> include/uapi/linux/net_namespace.h, which is fine, it would also extend
> coverage to:
> - include/uapi/linux/net_dropmon.h, which belongs to the
>     NETWORK DROP MONITOR section
> - include/uapi/linux/net_tstamp.h which, as per an earlier patch in this
>    series, belongs to the SOCKET TIMESTAMPING section

I think both the above files should belong also to the generic 
networking section. If there is agreement, I think can be adjusted with 
an incremental patch, instead of re-spinning the whole series - that I'm 
applying now.

Thanks,

Paolo
Simon Horman Aug. 22, 2024, 7:12 p.m. UTC | #2
On Thu, Aug 22, 2024 at 03:37:06PM +0200, Paolo Abeni wrote:
> On 8/21/24 10:46, Simon Horman wrote:
> > This aims to add limited globs to improve the coverage of header files
> > in the NETWORKING DRIVERS and NETWORKING [GENERAL] sections.
> > 
> > It is done so in a minimal way to exclude overlap with other sections.
> > And so as not to require "X" entries to exclude files otherwise
> > matched by these new globs.
> > 
> > While imperfect, due to it's limited nature, this does extend coverage
> > of header files by these sections. And aims to automatically cover
> > new files that seem very likely belong to these sections.
> > 
> > The include/linux/netdev* glob (both sections)
> > + Subsumes the entries for:
> >    - include/linux/netdevice.h
> > + Extends the sections to cover
> >    - include/linux/netdevice_xmit.h
> >    - include/linux/netdev_features.h
> > 
> > The include/uapi/linux/netdev* globs: (both sections)
> > + Subsumes the entries for:
> >    - include/linux/netdevice.h
> > + Extends the sections to cover
> >    - include/linux/netdev.h
> > 
> > The include/linux/skbuff* glob (NETWORKING [GENERAL] section only):
> > + Subsumes the entry for:
> >    - include/linux/skbuff.h
> > + Extends the section to cover
> >    - include/linux/skbuff_ref.h
> > 
> > A include/uapi/linux/net_* glob was not added to the NETWORKING [GENERAL]
> > section. Although it would subsume the entry for
> > include/uapi/linux/net_namespace.h, which is fine, it would also extend
> > coverage to:
> > - include/uapi/linux/net_dropmon.h, which belongs to the
> >     NETWORK DROP MONITOR section
> > - include/uapi/linux/net_tstamp.h which, as per an earlier patch in this
> >    series, belongs to the SOCKET TIMESTAMPING section
> 
> I think both the above files should belong also to the generic networking
> section. If there is agreement, I think can be adjusted with an incremental
> patch, instead of re-spinning the whole series - that I'm applying now.

Thanks.

I'm quite fine with adding a include/uapi/linux/net_* entry as a follow-up.
The reason that I didn't add it is to avoid including files in multiple
sections. But if there is consensus around that being ok then I have no
objections.
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index e5b9a4d9bc21..03d571b131eb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -15884,10 +15884,10 @@  F:	include/linux/fddidevice.h
 F:	include/linux/hippidevice.h
 F:	include/linux/if_*
 F:	include/linux/inetdevice.h
-F:	include/linux/netdevice.h
+F:	include/linux/netdev*
 F:	include/uapi/linux/cn_proc.h
 F:	include/uapi/linux/if_*
-F:	include/uapi/linux/netdevice.h
+F:	include/uapi/linux/netdev*
 F:	tools/testing/selftests/drivers/net/
 X:	drivers/net/wireless/
 
@@ -15940,13 +15940,13 @@  F:	include/linux/framer/framer.h
 F:	include/linux/in.h
 F:	include/linux/indirect_call_wrapper.h
 F:	include/linux/net.h
-F:	include/linux/netdevice.h
-F:	include/linux/skbuff.h
+F:	include/linux/netdev*
+F:	include/linux/skbuff*
 F:	include/net/
 F:	include/uapi/linux/in.h
 F:	include/uapi/linux/net.h
 F:	include/uapi/linux/net_namespace.h
-F:	include/uapi/linux/netdevice.h
+F:	include/uapi/linux/netdev*
 F:	lib/net_utils.c
 F:	lib/random32.c
 F:	net/