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

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

From
Philip Oakley <philipoakley@iee.org>
Date
Oct 25, 2012, 22:45 UTC
Message-ID
<F4D36C50EB6945CD8EB6E5AF73238148@PhilipOakley>
In-Reply-To
<20121025102638.GP8390@sigill.intra.peff.net>
From: "Jeff King" <peff@peff.net> Sent: Thursday, October 25, 2012 11:26 
AM
Show 26 quoted lines
> On Sun, Oct 21, 2012 at 10:34:08PM +0100, Philip Oakley wrote:
>
>> 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.
>
> I'd rather not mention a version number here, as we do not yet know
> which version (if any) will contain the feature. Besides, we write our
> documentation to match the current version, so as long as this is 
> queued
> on top of the new code, I do not see any reason to mention a version 
> at
> all.

I'd included it because of the manual's title caveat "(for version 1.5.3 or newer)", which I'd somehow thought was the matching date for the majority of text, hence my inclusion of the version. Begs the question what happened back then ;-)

>
> I'll tweak it while queueing.
Thank you.
>
> -Peff
> --
Previous: Jeff KingNext: Philip Oakley
Message 4 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.