system/linux
system/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux synced 2024-07-21 18:51:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation/process: use scripts/get_maintainer.pl on patches

Browse source 
Explain that, when collecting list of people to Cc the patch,
scripts/get_maintainer.pl should be used on patches, not on the
directories.  The behavior is quite different, because with "-f" on
a directory, the maintainers of individual files will not be shown.

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20220427185645.677039-1-krzysztof.kozlowski@linaro.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Krzysztof Kozlowski 2022-04-27 20:56:45 +02:00 committed by Jonathan Corbet
parent 0327b8b392
commit f1a693994b
3 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Documentation/doc-guide/contributing.rst
View file

@ -79,8 +79,9 @@ simplistic idea of what C comment blocks look like. This problem had been
present since that comment was added in 2016 — a full four years. Fixing present since that comment was added in 2016 — a full four years. Fixing
it was a matter of adding the missing asterisks. A quick look at the it was a matter of adding the missing asterisks. A quick look at the
history for that file showed what the normal format for subject lines is, history for that file showed what the normal format for subject lines is,
and ``scripts/get_maintainer.pl`` told me who should receive it. The and ``scripts/get_maintainer.pl`` told me who should receive it (pass paths to
resulting patch looked like this:: your patches as arguments to scripts/get_maintainer.pl). The resulting patch
looked like this::
[PATCH] PM / devfreq: Fix two malformed kerneldoc comments [PATCH] PM / devfreq: Fix two malformed kerneldoc comments

9
Documentation/process/3.Early-stage.rst
View file

@ -154,10 +154,11 @@ that the kernel developers have added a script to ease the process:
This script will return the current maintainer(s) for a given file or This script will return the current maintainer(s) for a given file or
directory when given the "-f" option. If passed a patch on the directory when given the "-f" option. If passed a patch on the
command line, it will list the maintainers who should probably receive command line, it will list the maintainers who should probably receive
copies of the patch. There are a number of options regulating how hard copies of the patch. This is the preferred way (unlike "-f" option) to get the
get_maintainer.pl will search for maintainers; please be careful about list of people to Cc for your patches. There are a number of options
using the more aggressive options as you may end up including developers regulating how hard get_maintainer.pl will search for maintainers; please be
who have no real interest in the code you are modifying. careful about using the more aggressive options as you may end up including
developers who have no real interest in the code you are modifying.
If all else fails, talking to Andrew Morton can be an effective way to If all else fails, talking to Andrew Morton can be an effective way to
track down a maintainer for a specific piece of code. track down a maintainer for a specific piece of code.

7
Documentation/process/submitting-patches.rst
View file

@ -227,9 +227,10 @@ Select the recipients for your patch
You should always copy the appropriate subsystem maintainer(s) on any patch You should always copy the appropriate subsystem maintainer(s) on any patch
to code that they maintain; look through the MAINTAINERS file and the to code that they maintain; look through the MAINTAINERS file and the
source code revision history to see who those maintainers are. The source code revision history to see who those maintainers are. The
script scripts/get_maintainer.pl can be very useful at this step. If you script scripts/get_maintainer.pl can be very useful at this step (pass paths to
cannot find a maintainer for the subsystem you are working on, Andrew your patches as arguments to scripts/get_maintainer.pl). If you cannot find a
Morton (akpm@linux-foundation.org) serves as a maintainer of last resort. maintainer for the subsystem you are working on, Andrew Morton
(akpm@linux-foundation.org) serves as a maintainer of last resort.
You should also normally choose at least one mailing list to receive a copy You should also normally choose at least one mailing list to receive a copy
of your patch set. linux-kernel@vger.kernel.org should be used by default of your patch set. linux-kernel@vger.kernel.org should be used by default