Skip to content

Commit e20d5a2

Browse files
committed
Merge branch 'sb/doc-submitting-patches-keep-notes'
* sb/doc-submitting-patches-keep-notes: SubmittingPatches: explain rationale for using --notes with format-patch
2 parents 7a353ec + 8601099 commit e20d5a2

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
@@ -176,8 +176,11 @@ message starts, you can put a "From: " line to name that person.
176176

177177
You often want to add additional explanation about the patch,
178178
other than the commit message itself. Place such "cover letter"
179-
material between the three dash lines and the diffstat. Git-notes
180-
can also be inserted using the `--notes` option.
179+
material between the three-dash line and the diffstat. For
180+
patches requiring multiple iterations of review and discussion,
181+
an explanation of changes between each iteration can be kept in
182+
Git-notes and inserted automatically following the three-dash
183+
line via `git format-patch --notes`.
181184

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

0 commit comments

Comments
 (0)