[PATCH v2] doc/SubmittingPatches: correct subject guidance
- Date: Wed, 8 Nov 2017 13:47:52 +0000
- From: Adam Dinwoodie <adam@xxxxxxxxxxxxx>
- Subject: [PATCH v2] doc/SubmittingPatches: correct subject guidance
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@xxxxxxxxxxxxx>
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
Documentation/SubmittingPatches | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 558d465b6..95abf6084 100644
@@ -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