path: root/Documentation
diff options
authorNikolai Weibull <>2005-12-08 23:28:05 (GMT)
committerJunio C Hamano <>2005-12-08 23:50:15 (GMT)
commit6f855371a53bf6a906e573f9ff32a2f9e1dfcfa8 (patch)
treeb5400063c63ab274fc3ec20dd6f9702dad1b8686 /Documentation
parentd4ce5f7e508c0a52aea2938cf2f7e25bf62eec3a (diff)
Documentation/git-format-patch.txt: Add --signoff, --check, and long option-names.
The documentation was lacking descriptions for the --signoff and --check options to git-format-patch. It was also missing the following long option-names: --output-directory (-o), --numbered (-n), --keep-subject (-k), --author (-a), --date (-d), and --mbox (-m). Signed-off-by: Nikolai Weibull <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation')
1 files changed, 17 insertions, 6 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 7a3abec..abb8fc8 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e-mail submission.
-'git-format-patch' [-n][-o <dir>|--stdout][-k][--mbox][--diff-options] <his> [<mine>]
+'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]
@@ -32,23 +32,34 @@ processing with applymbox.
--o <dir>::
+-o|--output-directory <dir>::
Use <dir> to store the resulting files, instead of the
current working directory.
Name output in '[PATCH n/m]' format.
Do not strip/add '[PATCH]' from the first line of the
commit log message.
---author, --date::
+-a|--author, -d|--date::
Output From: and Date: headers for commits made by
yourself as well. Usually these are output only for
commits made by people other than yourself.
+ Add `Signed-off-by:` line to the commit message, using
+ the committer identity of yourself.
+ Display suspicious lines in the patch. The definition
+ of 'suspicious lines' is currently the lines that has
+ trailing whitespaces, and the lines whose indentation
+ has a SP character immediately followed by a TAB
+ character.
Format the output files for closer to mbox format by
adding a phony Unix "From " line, so they can be
concatenated together and fed to `git-applymbox`.