mirrors/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2025-11-04 02:30:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MAINTAINERS: list the section entries in the preferred order

Browse source 
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 61f741645a ("parse-maintainers: Add section pattern
sorting")

Commit 5cdbec108f ("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>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: http://lkml.kernel.org/r/5aa5aad6fb1678230c260337dc066cd449a2bf32.camel@perches.com
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Joe Perches 2020-04-06 20:09:40 -07:00 committed by Linus Torvalds
parent af9c5d2e3b
commit 6680125ea5
1 changed files with 19 additions and 18 deletions
repo.diff.show_diff_stats Download patch file Download diff file Expand all files Collapse all files

37
MAINTAINERS
View file

@ -77,21 +77,13 @@ Tips for patch submitters
8. Happy hacking. 8. Happy hacking.
Descriptions of section entries Descriptions of section entries and preferred order
------------------------------- ---------------------------------------------------
M: *Mail* patches to: FullName <address@domain> M: *Mail* patches to: FullName <address@domain>
R: Designated *Reviewer*: FullName <address@domain> R: Designated *Reviewer*: FullName <address@domain>
These reviewers should be CCed on patches. These reviewers should be CCed on patches.
L: *Mailing list* that is relevant to this area 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: S: *Status*, one of the following:
Supported: Someone is actually paid to look after this. Supported: Someone is actually paid to look after this.
Maintained: Someone actually looks after it. Maintained: Someone actually looks after it.
@ -102,30 +94,39 @@ Descriptions of section entries
Obsolete: Old code. Something tagged obsolete generally means Obsolete: Old code. Something tagged obsolete generally means
it has been replaced by a better system and you it has been replaced by a better system and you
should be using that. 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 P: Subsystem Profile document for more details submitting
patches to the given subsystem. This is either an in-tree file, patches to the given subsystem. This is either an in-tree file,
or a URI. See Documentation/maintainer/maintainer-entry-profile.rst or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
for details. for details.
T: *SCM* tree type and location.
Type is one of: git, hg, quilt, stgit, topgit
F: *Files* and directories wildcard patterns. F: *Files* and directories wildcard patterns.
A trailing slash includes all files and subdirectory files. 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 and below drivers/net
F: drivers/net/* all files in drivers/net, but not below F: drivers/net/* all files in drivers/net, but not below
F: */net/* all files in "any top level directory"/net F: */net/* all files in "any top level directory"/net
One pattern per line. Multiple F: lines acceptable. One pattern per line. Multiple F: lines acceptable.
N: Files and directories *Regex* patterns.
N: [^a-z]tegra all files whose path contains the word tegra
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 X: *Excluded* files and directories that are NOT maintained, same
rules as F:. Files exclusions are tested before file matches. rules as F:. Files exclusions are tested before file matches.
Can be useful for excluding a specific subdirectory, for instance: Can be useful for excluding a specific subdirectory, for instance:
F: net/ F: net/
X: net/ipv6/ X: net/ipv6/
matches all files in and below net excluding 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 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.
K: *Content regex* (perl extended) pattern match in a patch or file. K: *Content regex* (perl extended) pattern match in a patch or file.
For instance: For instance:
K: of_get_profile K: of_get_profile