SubmittingPatches: explain rationale for using --notes with format-patch
While here, also change grammatically poor "three dash lines" to "three-dash line". Suggested-by: Stefan Beller <sbeller@google.com> Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Eric Sunshine committed
Dec 30, 2014 at 18:30 UTC
860109937386f2d103a71d3f703ad34cc1ebd136
1 file changed
+5
-2
Documentation/SubmittingPatches
+5
-2
@@ -175,8 +175,11 @@ message starts, you can put a "From: " line to name that person.
175
176
You often want to add additional explanation about the patch,
177
other than the commit message itself. Place such "cover letter"
178
-material between the three dash lines and the diffstat. Git-notes
179
-can also be inserted using the `--notes` option.
178
+material between the three-dash line and the diffstat. For
179
+patches requiring multiple iterations of review and discussion,
180
+an explanation of changes between each iteration can be kept in
181
+Git-notes and inserted automatically following the three-dash
182
+line via `git format-patch --notes`.
183
184
Do not attach the patch as a MIME attachment, compressed or not.
185
Do not let your e-mail client send quoted-printable. Do not let