summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2022-10-07 08:58:17 -0400
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2022-10-07 09:17:11 -0400
commitf9694a04abf2ee40c8428d3afd577774557e9926 (patch)
tree7114e5e2a3c018aefc69ab562e4655fa7aaf93cd /doc
parent9ca0f9e5a9ee0f7aaa86719cc61757734a37eee6 (diff)
downloadguix-f9694a04abf2ee40c8428d3afd577774557e9926.tar.gz
doc: Add git send-email tip in 'Submitting Patches' section.
* doc/contributing.texi (Submitting Patches): Add a tip detailing how to
prefix the subject line with the branch name the change should be installed
to.
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi25
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 7712f63d67..4b1eed1cb1 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1341,12 +1341,25 @@ guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master
 When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as
 a subject, if your patch is to be applied on a branch other than
 @code{master}, say @code{core-updates}, specify it in the subject like
-@samp{[PATCH core-updates] @dots{}}.  You may use your email client or
-the @command{git send-email} command (@pxref{Sending a Patch Series}).
-We prefer to get patches in plain text messages, either inline or as
-MIME attachments.  You are advised to pay attention if your email client
-changes anything like line breaks or indentation which could potentially
-break the patches.
+@samp{[PATCH core-updates] @dots{}}.
+
+@quotation Tip
+To add a prefix to the subject of your patch, you may use the
+@option{--subject-prefix} option of the @command{git format-patch} or
+@command{git send-email} commands, for example:
+@example
+git send-email --subject-prefix='PATCH core-updates' \
+  --to=guix-patches@@gnu.org -1
+@end example
+For more information, run @samp{man git-format-patch} and @samp{man
+git-send-email}.
+@end quotation
+
+You may use your email client or the @command{git send-email} command
+(@pxref{Sending a Patch Series}).  We prefer to get patches in plain
+text messages, either inline or as MIME attachments.  You are advised to
+pay attention if your email client changes anything like line breaks or
+indentation which could potentially break the patches.
 
 Expect some delay when you submit your very first patch to
 @email{guix-patches@@gnu.org}. You have to wait until you get an