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 User-Manual: Patch cover letter, three dashes, and --notes
Date: Sun, 21 Oct 2012 22:34:08 +0100	[thread overview]
Message-ID: <1350855250-2844-2-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1350855250-2844-1-git-send-email-philipoakley@iee.org>

Show that git format-patch can have a cover letter, include patch
commentary below the three dashes, and notes can also be
included.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
 Documentation/user-manual.txt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 85651b5..d918c53 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1787,6 +1787,11 @@ $ git format-patch origin
 will produce a numbered series of files in the current directory, one
 for each patch in the current branch but not in origin/HEAD.
 
+`git format-patch` can include an initial "cover letter". You can insert
+a commentary on individual patches using a three dash line after the
+commit message, and before the patch itself. `git format-patch --notes`
+(v1.8.1) will include the commit's notes in the similar manner.
+
 You can then import these into your mail client and send them by
 hand.  However, if you have a lot to send at once, you may prefer to
 use the linkgit:git-send-email[1] script to automate the process.
-- 
1.7.11.msysgit.1

  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 ` Philip Oakley [this message]
2012-10-25 10:26   ` [PATCH] Doc User-Manual: Patch cover letter, three dashes, and --notes 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 ` [PATCH] Doc format-patch: clarify --notes use case Philip Oakley
2012-10-25 10:25   ` 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-2-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).