@matheusbsbs / matheus-bagliano / commits / eaa54efc61
Fork 0

Documentation/git-commit.txt: Add long options and -- to documentation.

Added the following long options to documentation: * --all * --signoff * --verify * --no-verify * --edit Also added documentation for the -- option for terminating option parsing. 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 eaa54efc619879ef0d0f7b95f5357d8dab86a713
1 file changed +12 -6
Documentation/git-commit.txt
+12 -6
@@ -7,7 +7,7 @@ git-commit - Record your changes
7
8 SYNOPSIS
9 --------
10 -'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...
10 +'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>...
11
12 DESCRIPTION
13 -----------
@@ -22,7 +22,7 @@ information.
22
23 OPTIONS
24 -------
25 --a::
25 +-a|--all::
26 Update all paths in the index file.
27
28 -c or -C <commit>::
@@ -39,23 +39,29 @@ OPTIONS
39 -m <msg>::
40 Use the given <msg> as the commit message.
41
42 --s::
42 +-s|--signoff::
43 Add Signed-off-by line at the end of the commit message.
44
45 --v::
45 +-v|--verify::
46 Look for suspicious lines the commit introduces, and
47 abort committing if there is one. The definition of
48 'suspicious lines' is currently the lines that has
49 trailing whitespaces, and the lines whose indentation
50 has a SP character immediately followed by a TAB
51 - character.
51 + character. This is the default.
52
53 --e::
53 +-n|--no-verify::
54 + The opposite of `--verify`.
55 +
56 +-e|--edit::
57 The message taken from file with `-F`, command line with
58 `-m`, and from file with `-C` are usually used as the
59 commit log message unmodified. This option lets you
60 further edit the message taken from these sources.
61
62 +--::
63 + Do not interpret any more arguments as options.
64 +
65 <file>...::
66 Update specified paths in the index file before committing.
67