Doc format-patch: clarify --notes use case
Remove double negative, and include the repeat usage across versions of a patch series. Signed-off-by: Philip Oakley <philipoakley@iee.org> Signed-off-by: Jeff King <peff@peff.net>
Philip Oakley committed
Oct 21, 2012 at 22:34 UTC
6454d9f166236965c84650f72ecdd17e309394d6
1 file changed
+6
-7
Documentation/git-format-patch.txt
+6
-7
@@ -196,13 +196,12 @@ will want to ensure that threading is disabled for `git send-email`.
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.
199
+the commit that does not belong to the commit log message proper,
200
+and include it with the patch submission. While one can simply write
201
+these explanations after `format-patch` has run but before sending,
202
+keeping them as git notes allows them to be maintained between versions
203
+of the patch series (but see the discussion of the `notes.rewrite`
204
+configuration options in linkgit:git-notes[1] to use this workflow).
205
206
--[no]-signature=<signature>::
207
Add a signature to each message produced. Per RFC 3676 the signature