diff options
author | Junio C Hamano <gitster@pobox.com> | 2012-11-15 13:12:29 -0800 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2012-11-15 13:12:29 -0800 |
commit | 4eb2b9c1b93402514bbab7ad58ab8181526cd874 (patch) | |
tree | 75bbeb0edef3384164208c2373f0d1b406c6351a /git-format-patch.txt | |
parent | a129545d44f1f0fe9976ed87b9a7331bf239b7d8 (diff) | |
download | git-htmldocs-4eb2b9c1b93402514bbab7ad58ab8181526cd874.tar.gz |
Autogenerated HTML docs for v1.8.0-197-g5a907
Diffstat (limited to 'git-format-patch.txt')
-rw-r--r-- | git-format-patch.txt | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/git-format-patch.txt b/git-format-patch.txt index 6d43f5627..259dce499 100644 --- a/git-format-patch.txt +++ b/git-format-patch.txt @@ -20,7 +20,7 @@ SYNOPSIS [--ignore-if-in-upstream] [--subject-prefix=Subject-Prefix] [--to=<email>] [--cc=<email>] - [--cover-letter] [--quiet] + [--cover-letter] [--quiet] [--notes[=<ref>]] [<common diff options>] [ <since> | <revision range> ] @@ -191,6 +191,18 @@ will want to ensure that threading is disabled for `git send-email`. containing the shortlog and the overall diffstat. You can fill in a description in the file before sending it out. +--notes[=<ref>]:: + Append the notes (see linkgit:git-notes[1]) for the commit + 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, +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 is separated from the body by a line with '-- ' on it. If the |