* [PATCH] MAINTAINERS: List the section entries in the preferred order
@ 2020-03-26 23:26 Joe Perches
2020-03-27 8:40 ` Andy Shevchenko
0 siblings, 1 reply; 2+ messages in thread
From: Joe Perches @ 2020-03-26 23:26 UTC (permalink / raw)
To: Andrew Morton; +Cc: Andy Shevchenko, LKML
The MAINTAINERS file header has never shown a preferred order for the
section entries but scripts/parse-maintainers.pl added a preferred
order with commit 61f741645a35 ("parse-maintainers: Add section pattern
sorting")
Commit 5cdbec108fd2 ("parse-maintainers: Do not sort section content by
default") changed the preferred order to be a bit more sensible.
Update the MAINTAINERS section description block to use this preferred
section entry ordering.
Add a slightly better description for the N: entry too.
Signed-off-by: Joe Perches <joe@perches.com>
---
MAINTAINERS | 35 ++++++++++++++++++-----------------
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/MAINTAINERS b/MAINTAINERS
index 5060aa..ae4db4a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -77,21 +77,13 @@ Tips for patch submitters
8. Happy hacking.
-Descriptions of section entries
--------------------------------
+Descriptions of section entries and preferred order
+---------------------------------------------------
M: *Mail* patches to: FullName <address@domain>
R: Designated *Reviewer*: FullName <address@domain>
These reviewers should be CCed on patches.
L: *Mailing list* that is relevant to this area
- W: *Web-page* with status/info
- B: URI for where to file *bugs*. A web-page with detailed bug
- filing info, a direct bug tracker link, or a mailto: URI.
- C: URI for *chat* protocol, server and channel where developers
- usually hang out, for example irc://server/channel.
- Q: *Patchwork* web based patch tracking system site
- T: *SCM* tree type and location.
- Type is one of: git, hg, quilt, stgit, topgit
S: *Status*, one of the following:
Supported: Someone is actually paid to look after this.
Maintained: Someone actually looks after it.
@@ -102,30 +94,39 @@ Descriptions of section entries
Obsolete: Old code. Something tagged obsolete generally means
it has been replaced by a better system and you
should be using that.
+ W: *Web-page* with status/info
+ Q: *Patchwork* web based patch tracking system site
+ B: URI for where to file *bugs*. A web-page with detailed bug
+ filing info, a direct bug tracker link, or a mailto: URI.
+ C: URI for *chat* protocol, server and channel where developers
+ usually hang out, for example irc://server/channel.
P: Subsystem Profile document for more details submitting
patches to the given subsystem. This is either an in-tree file,
or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
for details.
+ T: *SCM* tree type and location.
+ Type is one of: git, hg, quilt, stgit, topgit
F: *Files* and directories wildcard patterns.
A trailing slash includes all files and subdirectory files.
F: drivers/net/ all files in and below drivers/net
F: drivers/net/* all files in drivers/net, but not below
F: */net/* all files in "any top level directory"/net
One pattern per line. Multiple F: lines acceptable.
+ X: *Excluded* files and directories that are NOT maintained, same
+ rules as F:. Files exclusions are tested before file matches.
+ Can be useful for excluding a specific subdirectory, for instance:
+ F: net/
+ X: net/ipv6/
+ matches all files in and below net excluding net/ipv6/
N: Files and directories *Regex* patterns.
- N: [^a-z]tegra all files whose path contains the word tegra
+ N: [^a-z]tegra all files whose path contains tegra
+ (not including files like integrator)
One pattern per line. Multiple N: lines acceptable.
scripts/get_maintainer.pl has different behavior for files that
match F: pattern and matches of N: patterns. By default,
get_maintainer will not look at git log history when an F: pattern
match occurs. When an N: match occurs, git log history is used
to also notify the people that have git commit signatures.
- X: *Excluded* files and directories that are NOT maintained, same
- rules as F:. Files exclusions are tested before file matches.
- Can be useful for excluding a specific subdirectory, for instance:
- F: net/
- X: net/ipv6/
- matches all files in and below net excluding net/ipv6/
K: *Content regex* (perl extended) pattern match in a patch or file.
For instance:
K: of_get_profile
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] MAINTAINERS: List the section entries in the preferred order
2020-03-26 23:26 [PATCH] MAINTAINERS: List the section entries in the preferred order Joe Perches
@ 2020-03-27 8:40 ` Andy Shevchenko
0 siblings, 0 replies; 2+ messages in thread
From: Andy Shevchenko @ 2020-03-27 8:40 UTC (permalink / raw)
To: Joe Perches; +Cc: Andrew Morton, Andy Shevchenko, LKML
On Fri, Mar 27, 2020 at 1:29 AM Joe Perches <joe@perches.com> wrote:
>
> The MAINTAINERS file header has never shown a preferred order for the
> section entries but scripts/parse-maintainers.pl added a preferred
> order with commit 61f741645a35 ("parse-maintainers: Add section pattern
> sorting")
>
> Commit 5cdbec108fd2 ("parse-maintainers: Do not sort section content by
> default") changed the preferred order to be a bit more sensible.
>
> Update the MAINTAINERS section description block to use this preferred
> section entry ordering.
>
FWIW,
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
thanks!
> Add a slightly better description for the N: entry too.
>
> Signed-off-by: Joe Perches <joe@perches.com>
> ---
> MAINTAINERS | 35 ++++++++++++++++++-----------------
> 1 file changed, 18 insertions(+), 17 deletions(-)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 5060aa..ae4db4a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -77,21 +77,13 @@ Tips for patch submitters
>
> 8. Happy hacking.
>
> -Descriptions of section entries
> --------------------------------
> +Descriptions of section entries and preferred order
> +---------------------------------------------------
>
> M: *Mail* patches to: FullName <address@domain>
> R: Designated *Reviewer*: FullName <address@domain>
> These reviewers should be CCed on patches.
> L: *Mailing list* that is relevant to this area
> - W: *Web-page* with status/info
> - B: URI for where to file *bugs*. A web-page with detailed bug
> - filing info, a direct bug tracker link, or a mailto: URI.
> - C: URI for *chat* protocol, server and channel where developers
> - usually hang out, for example irc://server/channel.
> - Q: *Patchwork* web based patch tracking system site
> - T: *SCM* tree type and location.
> - Type is one of: git, hg, quilt, stgit, topgit
> S: *Status*, one of the following:
> Supported: Someone is actually paid to look after this.
> Maintained: Someone actually looks after it.
> @@ -102,30 +94,39 @@ Descriptions of section entries
> Obsolete: Old code. Something tagged obsolete generally means
> it has been replaced by a better system and you
> should be using that.
> + W: *Web-page* with status/info
> + Q: *Patchwork* web based patch tracking system site
> + B: URI for where to file *bugs*. A web-page with detailed bug
> + filing info, a direct bug tracker link, or a mailto: URI.
> + C: URI for *chat* protocol, server and channel where developers
> + usually hang out, for example irc://server/channel.
> P: Subsystem Profile document for more details submitting
> patches to the given subsystem. This is either an in-tree file,
> or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
> for details.
> + T: *SCM* tree type and location.
> + Type is one of: git, hg, quilt, stgit, topgit
> F: *Files* and directories wildcard patterns.
> A trailing slash includes all files and subdirectory files.
> F: drivers/net/ all files in and below drivers/net
> F: drivers/net/* all files in drivers/net, but not below
> F: */net/* all files in "any top level directory"/net
> One pattern per line. Multiple F: lines acceptable.
> + X: *Excluded* files and directories that are NOT maintained, same
> + rules as F:. Files exclusions are tested before file matches.
> + Can be useful for excluding a specific subdirectory, for instance:
> + F: net/
> + X: net/ipv6/
> + matches all files in and below net excluding net/ipv6/
> N: Files and directories *Regex* patterns.
> - N: [^a-z]tegra all files whose path contains the word tegra
> + N: [^a-z]tegra all files whose path contains tegra
> + (not including files like integrator)
> One pattern per line. Multiple N: lines acceptable.
> scripts/get_maintainer.pl has different behavior for files that
> match F: pattern and matches of N: patterns. By default,
> get_maintainer will not look at git log history when an F: pattern
> match occurs. When an N: match occurs, git log history is used
> to also notify the people that have git commit signatures.
> - X: *Excluded* files and directories that are NOT maintained, same
> - rules as F:. Files exclusions are tested before file matches.
> - Can be useful for excluding a specific subdirectory, for instance:
> - F: net/
> - X: net/ipv6/
> - matches all files in and below net excluding net/ipv6/
> K: *Content regex* (perl extended) pattern match in a patch or file.
> For instance:
> K: of_get_profile
>
>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-03-27 8:41 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-03-26 23:26 [PATCH] MAINTAINERS: List the section entries in the preferred order Joe Perches
2020-03-27 8:40 ` Andy Shevchenko
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).