Skip to content

Commit 1a5f2e4

Browse files
committed
Merge branch 'ad/submitting-patches-title-decoration'
Doc update around use of "format-patch --subject-prefix" etc. * ad/submitting-patches-title-decoration: doc/SubmittingPatches: correct subject guidance
2 parents c9fdbca + f6be7ed commit 1a5f2e4

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

Documentation/SubmittingPatches

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,21 +203,26 @@ lose tabs that way if you are not careful.
203203

204204
It is a common convention to prefix your subject line with
205205
[PATCH]. This lets people easily distinguish patches from other
206-
e-mail discussions. Use of additional markers after PATCH and
207-
the closing bracket to mark the nature of the patch is also
208-
encouraged. E.g. [PATCH/RFC] is often used when the patch is
209-
not ready to be applied but it is for discussion, [PATCH v2],
210-
[PATCH v3] etc. are often seen when you are sending an update to
211-
what you have previously sent.
212-
213-
`git format-patch` command follows the best current practice to
206+
e-mail discussions. Use of markers in addition to PATCH within
207+
the brackets to describe the nature of the patch is also
208+
encouraged. E.g. [RFC PATCH] (where RFC stands for "request for
209+
comments") is often used to indicate a patch needs further
210+
discussion before being accepted, [PATCH v2], [PATCH v3] etc.
211+
are often seen when you are sending an update to what you have
212+
previously sent.
213+
214+
The `git format-patch` command follows the best current practice to
214215
format the body of an e-mail message. At the beginning of the
215216
patch should come your commit message, ending with the
216217
Signed-off-by: lines, and a line that consists of three dashes,
217218
followed by the diffstat information and the patch itself. If
218219
you are forwarding a patch from somebody else, optionally, at
219220
the beginning of the e-mail message just before the commit
220221
message starts, you can put a "From: " line to name that person.
222+
To change the default "[PATCH]" in the subject to "[<text>]", use
223+
`git format-patch --subject-prefix=<text>`. As a shortcut, you
224+
can use `--rfc` instead of `--subject-prefix="RFC PATCH"`, or
225+
`-v <n>` instead of `--subject-prefix="PATCH v<n>"`.
221226

222227
You often want to add additional explanation about the patch,
223228
other than the commit message itself. Place such "cover letter"

0 commit comments

Comments
 (0)