# Re: [PATCH] Documentation/SubmittingPatches: Explain the rationale of git notes 1 messages from 2014-12-30 to 2014-12-30. Participants: Eric Sunshine. Thread: https://gitlist.dev/t/38267 ## Eric Sunshine, 2014-12-30 23:30 Subject: Re: [PATCH] Documentation/SubmittingPatches: Explain the rationale of git notes Message-ID: <20141230233030.GA6344@flurp.local> URL: https://gitlist.dev/e/20141230233030.GA6344%40flurp.local In-Reply-To: ``` On Mon, Dec 29, 2014 at 06:48:48PM -0800, Stefan Beller wrote: > On Mon, Dec 29, 2014 at 6:47 PM, Stefan Beller wrote: > > From: Eric Sunshine > > As I just copied the whole text of Eric, I think > it would be better if Eric is credited for this commit. > > Eric, > I already added your sign off to help Junio just pick it up. > Please confirm that's ok. You can have my sign-off with a rewritten commit message (below) plus a minor grammatical fix to the existing text. -- >8 -- From: Eric Sunshine Subject: [PATCH] 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 --- Documentation/SubmittingPatches | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index e3c942e..8536bf3 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 -- 2.2.1.313.gcc831f2 ```