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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: "Jeff King" <peff@xxxxxxxx> Sent: Thursday, October 25, 2012 11:26 AM
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
--

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]