git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Stefan Beller <sbeller@google.com>
To: gitster@pobox.com, git@vger.kernel.org
Cc: Stefan Beller <sbeller@google.com>
Subject: [PATCHv2] Documentation/SubmittingPatches: Explain the rationale of git notes
Date: Mon, 29 Dec 2014 09:42:22 -0800	[thread overview]
Message-ID: <1419874942-9901-1-git-send-email-sbeller@google.com> (raw)
In-Reply-To: <xmqqwq5ja7s2.fsf@gitster.dls.corp.google.com>

This adds more explanation of why you want to have the --notes option
given to git format-patch.

Signed-off-by: Stefan Beller <sbeller@google.com>
---

Notes:
    Changes v2:
     * s/you are encouraged to/you may want to/
     * a stronger hint to use the git notes and then
       --notes for format-patch.

 Documentation/SubmittingPatches | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index e3c942e..f42c607 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -177,7 +177,12 @@ 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.
+can also be inserted using the `--notes` option. If you are one
+of those developers who cannot write perfect code the first time
+and need multiple iterations of review and discussion, you may
+want to keep track of the changes between different versions of
+a patch using notes and then also use the `--notes` option when
+preparing the patch for submission.
 
 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.62.g3f15098

  parent reply	other threads:[~2014-12-29 17:42 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <xmqq1tnx961q.fsf@gitster.dls.corp.google.com>
2014-12-18  1:08 ` [PATCH 1/2] Documentation/SubmittingPatches: Explain the rationale of git notes Stefan Beller
2014-12-18  1:08   ` [PATCH] Documentation/SubmittingPatches: unify whitespace/tabs for the DCO Stefan Beller
2014-12-18  1:08   ` [PATCH 2/2] " Stefan Beller
2014-12-22 17:55     ` Junio C Hamano
2014-12-22 17:55   ` [PATCH 1/2] Documentation/SubmittingPatches: Explain the rationale of git notes Junio C Hamano
2014-12-29 17:36     ` Stefan Beller
2014-12-29 17:42     ` Stefan Beller [this message]
2014-12-29 23:18       ` [PATCHv2] " Eric Sunshine
2014-12-29 23:21         ` Stefan Beller
2014-12-30 16:19           ` Junio C Hamano

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=1419874942-9901-1-git-send-email-sbeller@google.com \
    --to=sbeller@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).