@matheusbsbs / matheus-bagliano / commits / 6f855371a5
Fork 0

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 <nikolai@bitwi.se> Signed-off-by: Junio C Hamano <junkio@cox.net>

Nikolai Weibull committed Dec 9, 2005 at 00:28 UTC 6f855371a53bf6a906e573f9ff32a2f9e1dfcfa8
1 file changed +17 -6
Documentation/git-format-patch.txt
+17 -6
@@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e-mail submission.
8
9 SYNOPSIS
10 --------
11 -'git-format-patch' [-n][-o <dir>|--stdout][-k][--mbox][--diff-options] <his> [<mine>]
11 +'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]
12
13 DESCRIPTION
14 -----------
@@ -32,23 +32,34 @@ processing with applymbox.
32
33 OPTIONS
34 -------
35 --o <dir>::
35 +-o|--output-directory <dir>::
36 Use <dir> to store the resulting files, instead of the
37 current working directory.
38
39 --n::
39 +-n|--numbered::
40 Name output in '[PATCH n/m]' format.
41
42 --k::
42 +-k|--keep-subject::
43 Do not strip/add '[PATCH]' from the first line of the
44 commit log message.
45
46 ---author, --date::
46 +-a|--author, -d|--date::
47 Output From: and Date: headers for commits made by
48 yourself as well. Usually these are output only for
49 commits made by people other than yourself.
50
51 ---mbox::
51 +-s|--signoff::
52 + Add `Signed-off-by:` line to the commit message, using
53 + the committer identity of yourself.
54 +
55 +-c|--check::
56 + Display suspicious lines in the patch. The definition
57 + of 'suspicious lines' is currently the lines that has
58 + trailing whitespaces, and the lines whose indentation
59 + has a SP character immediately followed by a TAB
60 + character.
61 +
62 +-m|--mbox::
63 Format the output files for closer to mbox format by
64 adding a phony Unix "From " line, so they can be
65 concatenated together and fed to `git-applymbox`.