summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikolai Weibull <mailing-lists.git@rawuncut.elitemail.org>2005-12-08 23:28:05 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-12-08 23:50:14 (GMT)
commiteaa54efc619879ef0d0f7b95f5357d8dab86a713 (patch)
treead3908298a455ca6efcad0d09acb0f682da98e52
parent16cc50d12e8852583bde5c1116e4075f79d0a403 (diff)
downloadgit-eaa54efc619879ef0d0f7b95f5357d8dab86a713.zip
git-eaa54efc619879ef0d0f7b95f5357d8dab86a713.tar.gz
git-eaa54efc619879ef0d0f7b95f5357d8dab86a713.tar.bz2
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>
-rw-r--r--Documentation/git-commit.txt18
1 files changed, 12 insertions, 6 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 1edc278..b92cf48 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -7,7 +7,7 @@ git-commit - Record your changes
SYNOPSIS
--------
-'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...
+'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>...
DESCRIPTION
-----------
@@ -22,7 +22,7 @@ information.
OPTIONS
-------
--a::
+-a|--all::
Update all paths in the index file.
-c or -C <commit>::
@@ -39,23 +39,29 @@ OPTIONS
-m <msg>::
Use the given <msg> as the commit message.
--s::
+-s|--signoff::
Add Signed-off-by line at the end of the commit message.
--v::
+-v|--verify::
Look for suspicious lines the commit introduces, and
abort committing if there is one. 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.
+ character. This is the default.
--e::
+-n|--no-verify::
+ The opposite of `--verify`.
+
+-e|--edit::
The message taken from file with `-F`, command line with
`-m`, and from file with `-C` are usually used as the
commit log message unmodified. This option lets you
further edit the message taken from these sources.
+--::
+ Do not interpret any more arguments as options.
+
<file>...::
Update specified paths in the index file before committing.