From: Eric Sunshine Date: Tue, 30 Dec 2014 23:30:30 +0000 (-0500) Subject: SubmittingPatches: explain rationale for using --notes with format-patch X-Git-Tag: v2.3.0-rc0~3^2 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/860109937386f2d103a71d3f703ad34cc1ebd136?hp=c2e8e4b9da4d007b15faa2e3d407b2fd279f0572 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 Signed-off-by: Eric Sunshine Signed-off-by: Stefan Beller Signed-off-by: Junio C Hamano --- 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