Skip to content

Commit 8601099

Browse files
sunshinecogitster
authored andcommitted
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 <[email protected]> Signed-off-by: Eric Sunshine <[email protected]> Signed-off-by: Stefan Beller <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c2e8e4b commit 8601099

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Documentation/SubmittingPatches

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,11 @@ message starts, you can put a "From: " line to name that person.
175175

176176
You often want to add additional explanation about the patch,
177177
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`.
180183

181184
Do not attach the patch as a MIME attachment, compressed or not.
182185
Do not let your e-mail client send quoted-printable. Do not let

0 commit comments

Comments
 (0)