Skip to contentSkip to conversation

get_maintainer: add missing documentation for --git-blame-signatures

PATCH In review Brian Norris 2 participants 5 messages Nov 4, 2015 GET_MAINTAINER script

lore
Share & tools
lore

Brian Norris

author
#0 lore raw

PATCH v3 1/4 get_maintainer: add missing documentation for --git-blame-signatures

I really haven't used this option much myself, so feel free to improve on the documentation for it. I just noticed it while inspecting this script for undocumented features.

Signed-off-by Brian Norris <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Joe Perches <[email protected]>

---
v2 -> v3:
* no change

v1 -> v2:
https://lkml.org/lkml/2015/11/4/478
* reword the documentation to be more accurate

v1:
https://lkml.org/lkml/2015/8/19/442

 scripts/get_maintainer.pl | 1 +
 1 file changed, 1 insertion(+)
scripts/get_maintainer.pl +1 -0
index 98bae869f6d0..6ba0976e861e 100755
@@ -781,6 +781,7 @@ MAINTAINER field selection options:
     --git-max-maintainers => maximum maintainers to add (default: $email_git_max_maintainers)
     --git-min-percent => minimum percentage of commits required (default: $email_git_min_percent)
     --git-blame => use git blame to find modified commits for patch or file
+    --git-blame-signatures => when used with --git-blame, also include all commit signers
     --git-since => git history to use (default: $email_git_since)
     --hg-since => hg history to use (default: $email_hg_since)
     --interactive => display a menu (mostly useful if used with the --git option)
Signature · 1 line
2.6.0.rc2.230.g3dd15c0
author
#1 lore raw

PATCH v3 2/4 get_maintainer: it's '--pattern-depth', not '-pattern-depth'

Though it appears that Perl's GetOptions will take either, the latter is not documented in the options listing.

Signed-off-by Brian Norris <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Joe Perches <[email protected]>

---
v2 -> v3:
* no change

v2:
new in v2
https://lkml.org/lkml/2015/11/4/481

 scripts/get_maintainer.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/get_maintainer.pl +1 -1
index 6ba0976e861e..6c307276f3d6 100755
@@ -813,7 +813,7 @@ Other options:
   --help => show this help information
 
 Default options:
-  [--email --nogit --git-fallback --m --n --l --multiline -pattern-depth=0
+  [--email --nogit --git-fallback --m --n --l --multiline --pattern-depth=0
    --remove-duplicates --rolestats]
 
 Notes:
Signature · 1 line
2.6.0.rc2.230.g3dd15c0
author
#2 lore raw

PATCH v3 3/4 get_maintainer: add --no-foo options to --help

In reply to Brian Norris

Many flag options are boolean and support both a positive and a negative invocation from the command line. Some of these are even mentioned by example (e.g., --nogit is mentioned as a default option), but they aren't explicitly mentioned in the list of options. It happens that some of these are pretty important, as they are default-on, and to turn them off, you have to know about the --no-foo version.

Rather than clutter the whole help text with bracketed '--[no]foo', let's just mention the general rule, a la 'man gcc'.

Signed-off-by Brian Norris <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Joe Perches <[email protected]>

---
v2 -> v3:
* move to Notes section
* use <brackets>
* add --no-<foo> (Perl supports more than one form of negation)

v1 -> v2:
https://lkml.org/lkml/2015/11/4/479
* don't clutter with --[no]foo bracketing; just include this note up front; suggested by Joe
v1:
https://lkml.org/lkml/2015/8/19/441

 scripts/get_maintainer.pl | 3 +++
 1 file changed, 3 insertions(+)
scripts/get_maintainer.pl +3 -0
index 6c307276f3d6..145f1bf6472e 100755
@@ -845,6 +845,9 @@ Notes:
       Entries in this file can be any command line argument.
       This file is prepended to any additional command line arguments.
       Multiple lines and # comments are allowed.
+  Most options have both positive and negative forms.
+      The negative forms for --<foo> are --no<foo> and --no-<foo>.
+
 EOT
 }
Signature · 1 line
2.6.0.rc2.230.g3dd15c0
author
#3 lore raw

PATCH v3 4/4 get_maintainer: --r (list reviewer) is on by default

In reply to Brian Norris

We don't consistenly document the default value next to the option listing, but we do have a list of defaults here, so let's keep it up to date.

Signed-off-by Brian Norris <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Joe Perches <[email protected]>

---
v2 -> v3:
no change

v2:
new in v2
https://lkml.org/lkml/2015/11/4/480

 scripts/get_maintainer.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/get_maintainer.pl +1 -1
index 145f1bf6472e..0eec34ac45cd 100755
@@ -813,7 +813,7 @@ Other options:
   --help => show this help information
 
 Default options:
-  [--email --nogit --git-fallback --m --n --l --multiline --pattern-depth=0
+  [--email --nogit --git-fallback --m --r --n --l --multiline --pattern-depth=0
    --remove-duplicates --rolestats]
 
 Notes:
Signature · 1 line
2.6.0.rc2.230.g3dd15c0
maintainer
#4 lore raw
In reply to Brian Norris
Quoted 7 lines · Brian Norris

I really haven't used this option much myself, so feel free to improve on the documentation for it. I just noticed it while inspecting this script for undocumented features.

Signed-off-by Brian Norris <[email protected]>
Cc Andrew Morton <[email protected]>
Cc Joe Perches <[email protected]>

Thanks Brian.
Andrew, could you please pick these 4 patches up with my

Signed-off-by Joe Perches <[email protected]>