diff options
| author |  Eric Sunshine <sunshine@sunshineco.com> | 2014-12-30 18:30:30 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2015-01-07 10:21:17 -0800 |
| commit | 860109937386f2d103a71d3f703ad34cc1ebd136 (patch) | |
| tree | 2aaf10186656972774135fdaceee7a86cd2f50b9 | |
| parent | Prepare for 2.2.2 (diff) | |
| download | tgif-860109937386f2d103a71d3f703ad34cc1ebd136.tar.xz | |
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>
| -rw-r--r-- | Documentation/SubmittingPatches | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index fa71b5f0b6..85bc071ae7 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -175,8 +175,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 |