Skip to content

Commit

Permalink
SubmittingPatches: explain rationale for using --notes with format-patch
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Eric Sunshine authored and Junio C Hamano committed Jan 7, 2015
1 parent c2e8e4b commit 8601099
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions Documentation/SubmittingPatches
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8601099

Please sign in to comment.