docs/submitting patches: mention get_reviewers.pl
authorEmil Velikov <emil.velikov@collabora.com>
Mon, 21 Nov 2016 17:53:33 +0000 (17:53 +0000)
committerEmil Velikov <emil.l.velikov@gmail.com>
Tue, 22 Nov 2016 15:13:41 +0000 (15:13 +0000)
Mention the script - why/how to use alongside a useful trick to make it
work interactively (thanks Rob!).

Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Elie Tournier <tournier.elie@gmail.com>
docs/submittingpatches.html

index d2b605bf87880f7336a0784d7b5a6261ce0dee86..2d18c74decfc9fb11a9468d39c8389eaed70dfe0 100644 (file)
@@ -104,6 +104,19 @@ that should be documented with:
     Reviewed-by: Joe Hacker &lt;jhacker@foo.com&gt;
     Acked-by: Joe Hacker &lt;jhacker@foo.com&gt;
 </pre>
+<li>In order for your patch to reach the prospective reviewer easier/faster,
+use the script scripts/get_reviewer.pl to get a list of individuals and include
+them in the CC list.
+<br>
+Please use common sense and do <strong>not</strong> blindly add everyone.
+<br>
+<pre>
+    $ scripts/get_reviewer.pl --help # to get the the help screen
+    $ scripts/get_reviewer.pl -f src/egl/drivers/dri2/platform_android.c
+    Rob Herring <robh@kernel.org> (reviewer:ANDROID EGL SUPPORT,added_lines:188/700=27%,removed_lines:58/283=20%)
+    Tomasz Figa <tfiga@chromium.org> (reviewer:ANDROID EGL SUPPORT,authored:12/41=29%,added_lines:308/700=44%,removed_lines:115/283=41%)
+    Emil Velikov <emil.l.velikov@gmail.com> (authored:13/41=32%,removed_lines:76/283=27%)
+</pre>
 </ul>
 
 
@@ -335,6 +348,11 @@ commits before sending.
     git send-email --subject-prefix="PATCH v4" HEAD~8
     git send-email -v4 @~8 # shorter version, inherited from git format-patch
 </pre>
+<li> Configure git to use the get_reviewer.pl script interactively. Thus you
+can avoid adding the world to the CC list.
+<pre>
+    git config sendemail.cccmd "./scripts/get_reviewer.pl -i"
+</pre>
 </ul>