git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>, Eric Blake <eblake@redhat.com>
Subject: [PATCH] Doc format-patch: clarify --notes use case
Date: Sun, 21 Oct 2012 22:34:10 +0100	[thread overview]
Message-ID: <1350855250-2844-4-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1350855250-2844-1-git-send-email-philipoakley@iee.org>

Remove double negative, and include the repeat usage across
versions of a patch series.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
 Documentation/git-format-patch.txt | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 066dc8b..751009c 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -196,13 +196,10 @@ will want to ensure that threading is disabled for `git send-email`.
 	after the three-dash line.
 +
 The expected use case of this is to write supporting explanation for
-the commit that does not belong to the commit log message proper
-when (or after) you create the commit, and include it in your patch
-submission.  But if you can plan ahead and write it down, there may
-not be a good reason not to write it in your commit message, and if
-you can't, you can always edit the output of format-patch before
-sending it out, so the practical value of this option is somewhat
-dubious, unless your workflow is broken.
+the commit, that does not belong to the commit log message proper,
+and include it with the patch submission. The notes can be maintained
+between versions of the patch series. You can also edit the output of
+format-patch before sending.
 
 --[no]-signature=<signature>::
 	Add a signature to each message produced. Per RFC 3676 the signature
-- 
1.7.11.msysgit.1

  parent reply	other threads:[~2012-10-21 21:34 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-10-21 21:34 [PATCH] Doc SubmittingPatches: Mention --notes option after "cover letter" Philip Oakley
2012-10-21 21:34 ` [PATCH] Doc User-Manual: Patch cover letter, three dashes, and --notes Philip Oakley
2012-10-25 10:26   ` Jeff King
2012-10-25 22:45     ` Philip Oakley
2012-10-21 21:34 ` [PATCH] Doc notes: Include the format-patch --notes option Philip Oakley
2012-10-21 21:34 ` Philip Oakley [this message]
2012-10-25 10:25   ` [PATCH] Doc format-patch: clarify --notes use case Jeff King
2012-10-25 22:48     ` Philip Oakley
2012-10-26 13:26       ` Jeff King

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=1350855250-2844-4-git-send-email-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=eblake@redhat.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).