Code

Documentation/git-format-patch.txt: Add --signoff, --check, and long option-names.
authorNikolai Weibull <mailing-lists.git@rawuncut.elitemail.org>
Thu, 8 Dec 2005 23:28:05 +0000 (00:28 +0100)
committerJunio C Hamano <junkio@cox.net>
Thu, 8 Dec 2005 23:50:15 +0000 (15:50 -0800)
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 <nikolai@bitwi.se>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-format-patch.txt

index 7a3abec02e5b07533d11322b2ab9a3a89d2bd0d6..abb8fc89f4a2aeda697ce25ddadf1ecf3e93e1b6 100644 (file)
@@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e-mail submission.
 
 SYNOPSIS
 --------
-'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>]
 
 DESCRIPTION
 -----------
@@ -32,23 +32,34 @@ processing with applymbox.
 
 OPTIONS
 -------
--o <dir>::
+-o|--output-directory <dir>::
        Use <dir> to store the resulting files, instead of the
        current working directory.
 
--n::
+-n|--numbered::
        Name output in '[PATCH n/m]' format.
 
--k::
+-k|--keep-subject::
        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.
 
---mbox::
+-s|--signoff::
+       Add `Signed-off-by:` line to the commit message, using
+       the committer identity of yourself.
+
+-c|--check::
+        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.
+
+-m|--mbox::
        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`.