Documentation: decribe format-patch --notes
Even though I coded this, I am not sure what use scenarios would benefit from this option, so the description is unnecessarily negative at this moment. People who do want to use this feature need to come up with a more plausible use case and replace it. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Oct 19, 2012 at 13:01 UTC
e422c0cf1cd76e9c7957b46b317d1d8fabcdd8ee
1 file changed
+14
-1
Documentation/git-format-patch.txt
+14
-1
@@ -20,7 +20,7 @@ SYNOPSIS
20
[--ignore-if-in-upstream]
21
[--subject-prefix=Subject-Prefix]
22
[--to=<email>] [--cc=<email>]
23
- [--cover-letter] [--quiet]
23
+ [--cover-letter] [--quiet] [--notes[=<ref>]]
24
[<common diff options>]
25
[ <since> | <revision range> ]
26
@@ -191,6 +191,19 @@ will want to ensure that threading is disabled for `git send-email`.
191
containing the shortlog and the overall diffstat. You can
192
fill in a description in the file before sending it out.
193
194
+--notes[=<ref>]::
195
+ Append the notes (see linkgit:git-notes[1]) for the commit
196
+ after the three-dash line.
197
++
198
+The expected use case of this is to write supporting explanation for
199
+the commit that does not belong to the commit log message proper
200
+when (or after) you create the commit, and include it in your patch
201
+submission. But if you can plan ahead and write it down, there may
202
+not be a good reason not to write it in your commit message, and if
203
+you can't, you can always edit the output of format-patch before
204
+sending it out, so the practical value of this option is somewhat
205
+dubious, unless your workflow is broken.
206
+
207
--[no]-signature=<signature>::
208
Add a signature to each message produced. Per RFC 3676 the signature
209
is separated from the body by a line with '-- ' on it. If the