Re: [PATCH] Documentation/SubmittingPatches: Instruct how to use [PATCH] Subject header

From

Junio C Hamano <gitster@pobox.com>

Date

Feb 4, 2008, 00:55 UTC

Message-ID

<7v7ihlpmkm.fsf@gitster.siamese.dyndns.org>

In-Reply-To

<r6ft1sd1.fsf@blue.sea.net>

Jari Aalto <jari.aalto@cante.net> writes:

> Suggest putting additional message inside brackets, like [PATCH v2]
> for reworked content.
>
> Signed-off-by: Jari Aalto <jari.aalto AT cante.net>
> ---
>  Idea by Jakub Narebski
>
>  Documentation/SubmittingPatches |    3 +++
>  1 files changed, 3 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index de08d09..69ecbd3 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -37,6 +37,9 @@ Checklist (and a short version for the impatient):
>  	  maintainer (gitster@pobox.com). If you use
>  	  git-send-email(1), please test it first by sending
>  	  email to yourself.
> +        - If you rework the patch, announce the message
> +          in brackets. For example "[PATCH/RFC]", "[PATCH (resend)]",
> +          "[PATCH v2]" etc.
>  

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index de08d09..0661293 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -112,7 +112,12 @@ 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.
+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.
 
 "git format-patch" command follows the best current practice to
 format the body of an e-mail message.  At the beginning of the