[PATCH] doc/SubmittingPatches: correct subject guidance

[PATCH] doc/SubmittingPatches: correct subject guidance

[Adam Dinwoodie]

The examples and common practice for adding markers such as "RFC" or
"v2" to the subject of patch emails is to have them within the same
brackets as the "PATCH" text.  Update the description to match this
behaviour, rather than asserting such markers should be after the
closing bracket.

Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
---
 Documentation/SubmittingPatches | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b6..e91ce8269 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -184,7 +184,7 @@ lose tabs that way if you are not careful.
 
 It is a common convention to prefix your subject line with
 [PATCH].  This lets people easily distinguish patches from other
-e-mail discussions.  Use of additional markers after PATCH and
+e-mail discussions.  Use of additional markers between PATCH and
 the closing bracket to mark the nature of the patch is also
 encouraged.  E.g. [PATCH/RFC] is often used when the patch is
 not ready to be applied but it is for discussion, [PATCH v2],
-- 
2.14.3

[PATCH v2] doc/SubmittingPatches: correct subject guidance

[Adam Dinwoodie]

The examples and common practice for adding markers such as "RFC" or
"v2" to the subject of patch emails is to have them within the same
brackets as the "PATCH" text, not after the closing bracket.  Further,
the practice of `git format-patch` and the like, as well as what appears
to be the more common pratice on the mailing list, is to use "[RFC
PATCH]", not "[PATCH/RFC]".

Update the SubmittingPatches article to match.

Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
---

I'm re-rolling this patch with some more substantive changes, as a bit
more research points to (a) "RFC PATCH" being more common on this
mailing list than "PATCH/RFC", at least in recent usage, and (b) so the
instructions match the best practice according to `git format-patch` and
friends.

 Documentation/SubmittingPatches | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b6..95abf6084 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -184,12 +184,14 @@ lose tabs that way if you are not careful.
 
 It is a common convention to prefix your subject line with
 [PATCH].  This lets people easily distinguish patches from other
-e-mail discussions.  Use of additional markers after PATCH and
-the closing bracket to mark the nature of the patch is also
-encouraged.  E.g. [PATCH/RFC] is often used when the patch is
-not ready to be applied but it is for discussion, [PATCH v2],
-[PATCH v3] etc. are often seen when you are sending an update to
-what you have previously sent.
+e-mail discussions.  Use of markers in addition to PATCH within
+the brackets to describe the nature of the patch is also
+encouraged.  E.g. [RFC PATCH] is often used when the patch is not
+ready to be applied but it is for discussion, and can be added
+with the `--rfc` argument to `git format-patch` or `git
+send-email`, while [PATCH v2], [PATCH v3] etc.  are often seen
+when you are sending an update to what you have previously sent,
+and can be added with the `-v <n>` arguments to the same commands.
 
 "git format-patch" command follows the best current practice to
 format the body of an e-mail message.  At the beginning of the
-- 
2.14.3

Re: [PATCH v2] doc/SubmittingPatches: correct subject guidance

[Eric Sunshine]

On Wed, Nov 8, 2017 at 8:47 AM, Adam Dinwoodie <adam@dinwoodie.org> wrote:
> The examples and common practice for adding markers such as "RFC" or
> "v2" to the subject of patch emails is to have them within the same
> brackets as the "PATCH" text, not after the closing bracket.  Further,
> the practice of `git format-patch` and the like, as well as what appears
> to be the more common pratice on the mailing list, is to use "[RFC
> PATCH]", not "[PATCH/RFC]".
>
> Update the SubmittingPatches article to match.
>
> Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
> ---
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> @@ -184,12 +184,14 @@ lose tabs that way if you are not careful.
>  It is a common convention to prefix your subject line with
>  [PATCH].  This lets people easily distinguish patches from other
> -e-mail discussions.  Use of additional markers after PATCH and
> -the closing bracket to mark the nature of the patch is also
> -encouraged.  E.g. [PATCH/RFC] is often used when the patch is
> -not ready to be applied but it is for discussion, [PATCH v2],
> -[PATCH v3] etc. are often seen when you are sending an update to
> -what you have previously sent.
> +e-mail discussions.  Use of markers in addition to PATCH within
> +the brackets to describe the nature of the patch is also
> +encouraged.  E.g. [RFC PATCH] is often used when the patch is not
> +ready to be applied but it is for discussion, and can be added
> +with the `--rfc` argument to `git format-patch` or `git
> +send-email`, while [PATCH v2], [PATCH v3] etc.  are often seen

It has become a bit of a run-on sentence, but aside from that and the
unnecessary extra whitespace between "etc." and "are", it looks good
to me.

> +when you are sending an update to what you have previously sent,
> +and can be added with the `-v <n>` arguments to the same commands.

Re: [PATCH v2] doc/SubmittingPatches: correct subject guidance

[Adam Dinwoodie]

On Wednesday 08 November 2017 at 09:10 am -0500, Eric Sunshine wrote:
> On Wed, Nov 8, 2017 at 8:47 AM, Adam Dinwoodie <adam@dinwoodie.org> wrote:
> > +e-mail discussions.  Use of markers in addition to PATCH within
> > +the brackets to describe the nature of the patch is also
> > +encouraged.  E.g. [RFC PATCH] is often used when the patch is not
> > +ready to be applied but it is for discussion, and can be added
> > +with the `--rfc` argument to `git format-patch` or `git
> > +send-email`, while [PATCH v2], [PATCH v3] etc.  are often seen
> 
> It has become a bit of a run-on sentence, but aside from that and the
> unnecessary extra whitespace between "etc." and "are", it looks good
> to me.

Both good points, thank you!  I suspect the extra whitespace was a
result of Vim being "helpful" when reflowing the text.

I'll re-spin now with fixed whitespace and breaking up the sentence a
bit.

[PATCH v3] doc/SubmittingPatches: correct subject guidance

[Adam Dinwoodie]

The examples and common practice for adding markers such as "RFC" or
"v2" to the subject of patch emails is to have them within the same
brackets as the "PATCH" text, not after the closing bracket.  Further,
the practice of `git format-patch` and the like, as well as what appears
to be the more common pratice on the mailing list, is to use "[RFC
PATCH]", not "[PATCH/RFC]".

Update the SubmittingPatches article to match, and to reference the
`format-patch` helper arguments.

Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/SubmittingPatches | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b6..ae59fd9d0 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -184,21 +184,25 @@ lose tabs that way if you are not careful.
 
 It is a common convention to prefix your subject line with
 [PATCH].  This lets people easily distinguish patches from other
-e-mail discussions.  Use of additional markers after PATCH and
-the closing bracket to mark the nature of the patch is also
-encouraged.  E.g. [PATCH/RFC] is often used when the patch is
+e-mail discussions.  Use of markers in addition to PATCH within
+the brackets to describe the nature of the patch is also
+encouraged.  E.g. [RFC PATCH] is often used when the patch is
 not ready to be applied but it is for discussion, [PATCH v2],
 [PATCH v3] etc. are often seen when you are sending an update to
 what you have previously sent.
 
-"git format-patch" command follows the best current practice to
+The "git format-patch" command follows the best current practice to
 format the body of an e-mail message.  At the beginning of the
 patch should come your commit message, ending with the
 Signed-off-by: lines, and a line that consists of three dashes,
 followed by the diffstat information and the patch itself.  If
 you are forwarding a patch from somebody else, optionally, at
 the beginning of the e-mail message just before the commit
 message starts, you can put a "From: " line to name that person.
+To change the bracketed text at the start of the subject, use
+`git format-patch --subject-prefix=<text>`.  As a shortcut, you
+can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
+`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
 
 You often want to add additional explanation about the patch,
 other than the commit message itself.  Place such "cover letter"
-- 
2.14.3

Re: [PATCH v3] doc/SubmittingPatches: correct subject guidance

[Eric Sunshine]

On Thu, Nov 9, 2017 at 8:08 AM, Adam Dinwoodie <adam@dinwoodie.org> wrote:
> The examples and common practice for adding markers such as "RFC" or
> "v2" to the subject of patch emails is to have them within the same
> brackets as the "PATCH" text, not after the closing bracket.  Further,
> the practice of `git format-patch` and the like, as well as what appears
> to be the more common pratice on the mailing list, is to use "[RFC
> PATCH]", not "[PATCH/RFC]".
>
> Update the SubmittingPatches article to match, and to reference the
> `format-patch` helper arguments.
>
> Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
> ---
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> @@ -184,21 +184,25 @@ lose tabs that way if you are not careful.
>  It is a common convention to prefix your subject line with
>  [PATCH].  This lets people easily distinguish patches from other
> -e-mail discussions.  Use of additional markers after PATCH and
> -the closing bracket to mark the nature of the patch is also
> -encouraged.  E.g. [PATCH/RFC] is often used when the patch is
> +e-mail discussions.  Use of markers in addition to PATCH within
> +the brackets to describe the nature of the patch is also
> +encouraged.  E.g. [RFC PATCH] is often used when the patch is
>  not ready to be applied but it is for discussion, [PATCH v2],

Not a new problem, but since you're here cleaning this up, the "not
ready to be applied but it is for discussion" makes for a clunky read.
Perhaps something roughly like:

    E.g. [RFC PATCH] is often used to indicate that a patch needs
    further discussion ("request for comments") before being
    accepted.

>  [PATCH v3] etc. are often seen when you are sending an update to
>  what you have previously sent.
>
> -"git format-patch" command follows the best current practice to
> +The "git format-patch" command follows the best current practice to
>  format the body of an e-mail message.  At the beginning of the
>  patch should come your commit message, ending with the
>  Signed-off-by: lines, and a line that consists of three dashes,
>  followed by the diffstat information and the patch itself.  If
>  you are forwarding a patch from somebody else, optionally, at
>  the beginning of the e-mail message just before the commit
>  message starts, you can put a "From: " line to name that person.
> +To change the bracketed text at the start of the subject, use
> +`git format-patch --subject-prefix=<text>`.  As a shortcut, you

This may be nit-picky, but it took a bit of thought for me to work out
what "bracketed text at the start of the subject" meant. I wonder if
it would be clearer just to spell it out:

    To change the default "[PATCH]" in the subject to "[<text>]", use
    `git format-patch --subject-prefix=<text>`.

> +can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
> +`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.

Overall, this is much easier to digest than the run-on sentence in v2. Thanks.

[PATCH v4] doc/SubmittingPatches: correct subject guidance

[Adam Dinwoodie]

The examples and common practice for adding markers such as "RFC" or
"v2" to the subject of patch emails is to have them within the same
brackets as the "PATCH" text, not after the closing bracket.  Further,
the practice of `git format-patch` and the like, as well as what appears
to be the more common pratice on the mailing list, is to use "[RFC
PATCH]", not "[PATCH/RFC]".

Update the SubmittingPatches article to match and to reference the
`format-patch` helper arguments, and also make some minor text
clarifications in the area.

Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
---

Notes:
    Changes since v3:
    - Clarified meaning of "RFC" per Eric's suggestion
    - Made the impact of --subject-prefix and friends clearer per Eric's
      suggestion
    
    Thank you for your nitpicking, Eric, it's useful and very much
    appreciated :)

 Documentation/SubmittingPatches | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b6..89f239071 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -184,21 +184,26 @@ lose tabs that way if you are not careful.
 
 It is a common convention to prefix your subject line with
 [PATCH].  This lets people easily distinguish patches from other
-e-mail discussions.  Use of additional markers after PATCH and
-the closing bracket to mark the nature of the patch is also
-encouraged.  E.g. [PATCH/RFC] is often used when the patch is
-not ready to be applied but it is for discussion, [PATCH v2],
-[PATCH v3] etc. are often seen when you are sending an update to
-what you have previously sent.
+e-mail discussions.  Use of markers in addition to PATCH within
+the brackets to describe the nature of the patch is also
+encouraged.  E.g. [RFC PATCH] (where RFC stands for "request for
+comments") is often used to indicate a patch needs further
+discussion before being accepted, [PATCH v2], [PATCH v3] etc.
+are often seen when you are sending an update to what you have
+previously sent.
 
-"git format-patch" command follows the best current practice to
+The "git format-patch" command follows the best current practice to
 format the body of an e-mail message.  At the beginning of the
 patch should come your commit message, ending with the
 Signed-off-by: lines, and a line that consists of three dashes,
 followed by the diffstat information and the patch itself.  If
 you are forwarding a patch from somebody else, optionally, at
 the beginning of the e-mail message just before the commit
 message starts, you can put a "From: " line to name that person.
+To change the default "[PATCH]" in the subject to "[<text>]", use
+`git format-patch --subject-prefix=<text>`.  As a shortcut, you
+can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
+`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
 
 You often want to add additional explanation about the patch,
 other than the commit message itself.  Place such "cover letter"
-- 
2.14.3

Re: [PATCH v4] doc/SubmittingPatches: correct subject guidance

[Josh Triplett]

On Fri, Nov 10, 2017 at 03:02:50PM +0000, Adam Dinwoodie wrote:
> The examples and common practice for adding markers such as "RFC" or
> "v2" to the subject of patch emails is to have them within the same
> brackets as the "PATCH" text, not after the closing bracket.  Further,
> the practice of `git format-patch` and the like, as well as what appears
> to be the more common pratice on the mailing list, is to use "[RFC
> PATCH]", not "[PATCH/RFC]".
> 
> Update the SubmittingPatches article to match and to reference the
> `format-patch` helper arguments, and also make some minor text
> clarifications in the area.
> 
> Signed-off-by: Adam Dinwoodie <adam@dinwoodie.org>
> Helped-by: Eric Sunshine <sunshine@sunshineco.com>

This looks great! Thank you for updating this documentation.

Reviewed-by: Josh Triplett <josh@joshtriplett.org>

> ---
> 
> Notes:
>     Changes since v3:
>     - Clarified meaning of "RFC" per Eric's suggestion
>     - Made the impact of --subject-prefix and friends clearer per Eric's
>       suggestion
>     
>     Thank you for your nitpicking, Eric, it's useful and very much
>     appreciated :)
> 
>  Documentation/SubmittingPatches | 19 ++++++++++++-------
>  1 file changed, 12 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index 558d465b6..89f239071 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -184,21 +184,26 @@ lose tabs that way if you are not careful.
>  
>  It is a common convention to prefix your subject line with
>  [PATCH].  This lets people easily distinguish patches from other
> -e-mail discussions.  Use of additional markers after PATCH and
> -the closing bracket to mark the nature of the patch is also
> -encouraged.  E.g. [PATCH/RFC] is often used when the patch is
> -not ready to be applied but it is for discussion, [PATCH v2],
> -[PATCH v3] etc. are often seen when you are sending an update to
> -what you have previously sent.
> +e-mail discussions.  Use of markers in addition to PATCH within
> +the brackets to describe the nature of the patch is also
> +encouraged.  E.g. [RFC PATCH] (where RFC stands for "request for
> +comments") is often used to indicate a patch needs further
> +discussion before being accepted, [PATCH v2], [PATCH v3] etc.
> +are often seen when you are sending an update to what you have
> +previously sent.
>  
> -"git format-patch" command follows the best current practice to
> +The "git format-patch" command follows the best current practice to
>  format the body of an e-mail message.  At the beginning of the
>  patch should come your commit message, ending with the
>  Signed-off-by: lines, and a line that consists of three dashes,
>  followed by the diffstat information and the patch itself.  If
>  you are forwarding a patch from somebody else, optionally, at
>  the beginning of the e-mail message just before the commit
>  message starts, you can put a "From: " line to name that person.
> +To change the default "[PATCH]" in the subject to "[<text>]", use
> +`git format-patch --subject-prefix=<text>`.  As a shortcut, you
> +can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
> +`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
>  
>  You often want to add additional explanation about the patch,
>  other than the commit message itself.  Place such "cover letter"
> -- 
> 2.14.3
>