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

[PATCH] Doc User-Manual: Patch cover letter, three dashes, and --notes

From
Philip Oakley <philipoakley@iee.org>
Date
Oct 21, 2012, 21:34 UTC
Message-ID
<1350855250-2844-2-git-send-email-philipoakley@iee.org>
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
Previous: Philip OakleyNext: Jeff King
Message 2 of 9 in “Doc SubmittingPatches: Mention --notes option after "cover letter"”
  1. Doc SubmittingPatches: Mention --notes option after "cover letter"Philip Oakley, Oct 21, 2012
  2. Doc User-Manual: Patch cover letter, three dashes, and --notesPhilip Oakley, Oct 21, 2012
  3. Jeff KingOct 25, 2012
  4. Philip OakleyOct 25, 2012
  5. Doc notes: Include the format-patch --notes optionPhilip Oakley, Oct 21, 2012
  6. Doc format-patch: clarify --notes use casePhilip Oakley, Oct 21, 2012
  7. Jeff KingOct 25, 2012
  8. Philip OakleyOct 25, 2012
  9. Jeff KingOct 26, 2012

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.