Re: [PATCH/RFC 2/2] format-patch: show notes as message after the ---

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 26, 2011, 17:39 UTC
Message-ID: <7vsjt4ewsy.fsf@alter.siamese.dyndns.org>
In-Reply-To: <826def15eb7204ee30fc4c358f72103ec75b4e42.1303808057.git.git@drmicha.warpmail.net>

Michael J Gruber <git@drmicha.warpmail.net> writes:

Show 28 quoted lines

> When requesting notes with "--notes", "format-patch" produces notes
> within the commit message which "am" misunderstands as being part of the
> message.
>
> Change this so that notes are displayed after an additional "---". Any
> "am" (old or new) will ignore that, so that it is a safe place for
> additional comments:
>
> Log message
> "---"
> notes
> "---"
> diffstat
> patch
>
> (The first "---" appears only when there is a note, of course.)
>
> Later on (say with "--format-notes") the output format can be changed
> easily to accomodate a future "am" which knows how to create notes from
> such patches.
>
> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
> ---
> Reducing the output format to one "---" only is not only complicated (the notes
> separator is generated in a quite different place from the patch separator)
> but also unnecessary (am reads the patch anyways) and not even preferable (to
> give a clear separation of the parts).
> ---

If you show more than one note, separating them with "---" in between would be a good idea so that reader can tell where each note ends, but I'd rather not to see the "---" after the last note. Put just a blank line here instead.