diff mbox series

[bug#41191] doc: Specify the branch name in the title of a patch.

Message ID 20200511184254.21231-1-brice@waegenei.re
State Accepted
Headers show
Series [bug#41191] doc: Specify the branch name in the title of a patch. | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch success View Laminar job

Commit Message

Brice Waegeneire May 11, 2020, 6:42 p.m. UTC 
* doc/contributing.texi (Submitting Patches): Add branch name in the
title of a patch if different than master.
---
 doc/contributing.texi | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

Comments

Leo Famulari May 11, 2020, 7:43 p.m. UTC | #1 
On Mon, May 11, 2020 at 08:42:54PM +0200, Brice Waegeneire wrote:
> +a subject, if your patch is to be applied on a branch other than master,
> +say @code{core-updates}, specify it in the subject like @samp{[PATCH

Wrap both master and core-updates in @code? Or neither?

Otherwise LGTM!
Brice Waegeneire May 12, 2020, 8:12 p.m. UTC | #2 
On 2020-05-11 19:43, Leo Famulari wrote:
> On Mon, May 11, 2020 at 08:42:54PM +0200, Brice Waegeneire wrote:
>> +a subject, if your patch is to be applied on a branch other than 
>> master,
>> +say @code{core-updates}, specify it in the subject like @samp{[PATCH
> 
> Wrap both master and core-updates in @code? Or neither?
> 
> Otherwise LGTM!

I have wrapped master in @code, pushed as 
a1891cbffb9909d4a74faf242f28f0f2e998eb2f.

Thank you for the review Leo!
diff mbox series

Patch

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 9583120742..618d9008cc 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1083,12 +1083,14 @@  guix pull --url=/path/to/your/checkout --profile=/tmp/guix.master
 @end enumerate
 
 When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as
-a subject.  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.
+a subject, if your patch is to be applied on a branch other than 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.
 
 When a bug is resolved, please close the thread by sending an email to
 @email{@var{NNN}-done@@debbugs.gnu.org}.