git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Documentation/SubmittingPatches: Explain the rationale of git notes

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Dec 30, 2014, 23:30 UTC
Message-ID
<20141230233030.GA6344@flurp.local>
In-Reply-To
<CAGZ79kZcnu4ArwfEVNMh+mQjkYAvj=rJXP4jz2o6YF1t5=SQ6w@mail.gmail.com>
On Mon, Dec 29, 2014 at 06:48:48PM -0800, Stefan Beller wrote:
Show 9 quoted lines
> 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
Message 1 of 1 in “Re: [PATCH] Documentation/SubmittingPatches: Explain the rationale of git notes”
  1. Eric SunshineDec 30, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.