summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-01-12 19:38:54 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-01-12 19:38:55 (GMT)
commite20d5a2c4433daf09797d9e4e9f6c4eaedec86dd (patch)
tree69234204ad84335a8f5ec5fc1b857b014ac10126
parent7a353ec965df6e1b17ee52360c1369ebe2a961ec (diff)
parent860109937386f2d103a71d3f703ad34cc1ebd136 (diff)
downloadgit-e20d5a2c4433daf09797d9e4e9f6c4eaedec86dd.zip
git-e20d5a2c4433daf09797d9e4e9f6c4eaedec86dd.tar.gz
git-e20d5a2c4433daf09797d9e4e9f6c4eaedec86dd.tar.bz2
Merge branch 'sb/doc-submitting-patches-keep-notes'
* sb/doc-submitting-patches-keep-notes: SubmittingPatches: explain rationale for using --notes with format-patch
-rw-r--r--Documentation/SubmittingPatches7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 16d5d2b..ef0eeb4 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -176,8 +176,11 @@ message starts, you can put a "From: " line to name that person.
You often want to add additional explanation about the patch,
other than the commit message itself. Place such "cover letter"
-material between the three dash lines and the diffstat. Git-notes
-can also be inserted using the `--notes` option.
+material between the three-dash line and the diffstat. For
+patches requiring multiple iterations of review and discussion,
+an explanation of changes between each iteration can be kept in
+Git-notes and inserted automatically following the three-dash
+line via `git format-patch --notes`.
Do not attach the patch as a MIME attachment, compressed or not.
Do not let your e-mail client send quoted-printable. Do not let