diff options
author | Philip Oakley <philipoakley@iee.org> | 2012-10-21 22:34:10 +0100 |
---|---|---|
committer | Jeff King <peff@peff.net> | 2012-10-26 09:25:04 -0400 |
commit | 6454d9f166236965c84650f72ecdd17e309394d6 (patch) | |
tree | 3d89b5e79ab8edf0bf583950305eda49b0ad37ec /Documentation | |
parent | Doc notes: Include the format-patch --notes option (diff) | |
download | tgif-6454d9f166236965c84650f72ecdd17e309394d6.tar.xz |
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>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-format-patch.txt | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 066dc8be45..259dce4994 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -196,13 +196,12 @@ will want to ensure that threading is disabled for `git send-email`. after the three-dash line. + The expected use case of this is to write supporting explanation for -the commit that does not belong to the commit log message proper -when (or after) you create the commit, and include it in your patch -submission. But if you can plan ahead and write it down, there may -not be a good reason not to write it in your commit message, and if -you can't, you can always edit the output of format-patch before -sending it out, so the practical value of this option is somewhat -dubious, unless your workflow is broken. +the commit that does not belong to the commit log message proper, +and include it with the patch submission. While one can simply write +these explanations after `format-patch` has run but before sending, +keeping them as git notes allows them to be maintained between versions +of the patch series (but see the discussion of the `notes.rewrite` +configuration options in linkgit:git-notes[1] to use this workflow). --[no]-signature=<signature>:: Add a signature to each message produced. Per RFC 3676 the signature |