From: Eric Sunshine <sunshine@sunshineco.com>
To: Stefan Beller <sbeller@google.com>
Cc: Junio C Hamano <gitter@pobox.com>, git@vger.kernel.org
Subject: Re: [PATCH] Documentation/SubmittingPatches: Explain the rationale of git notes
Date: Tue, 30 Dec 2014 18:30:30 -0500 [thread overview]
Message-ID: <20141230233030.GA6344@flurp.local> (raw)
In-Reply-To: <CAGZ79kZcnu4ArwfEVNMh+mQjkYAvj=rJXP4jz2o6YF1t5=SQ6w@mail.gmail.com>
On Mon, Dec 29, 2014 at 06:48:48PM -0800, Stefan Beller wrote:
> On Mon, Dec 29, 2014 at 6:47 PM, Stefan Beller <sbeller@google.com> wrote:
> > From: Eric Sunshine <sunshine@sunshineco.com>
>
> 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 <sunshine@sunshineco.com>
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 <sbeller@google.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---
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
parent reply other threads:[~2014-12-30 23:30 UTC|newest]
Thread overview: expand[flat|nested] mbox.gz Atom feed
[parent not found: <CAGZ79kZcnu4ArwfEVNMh+mQjkYAvj=rJXP4jz2o6YF1t5=SQ6w@mail.gmail.com>]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20141230233030.GA6344@flurp.local \
--to=sunshine@sunshineco.com \
--cc=git@vger.kernel.org \
--cc=gitter@pobox.com \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).