undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Nikolai Weibull 2005-12-09 00:28:05 +01:00 committed by Junio C Hamano
parent 16cc50d12e
commit eaa54efc61
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/git-commit.txt
View File

@ -7,7 +7,7 @@ git-commit - Record your changes
SYNOPSIS 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 DESCRIPTION
----------- -----------
@ -22,7 +22,7 @@ information.
OPTIONS OPTIONS
------- -------
-a:: -a|--all::
Update all paths in the index file. Update all paths in the index file.
-c or -C <commit>:: -c or -C <commit>::
@ -39,23 +39,29 @@ OPTIONS
-m <msg>:: -m <msg>::
Use the given <msg> as the commit message. Use the given <msg> as the commit message.
-s:: -s|--signoff::
Add Signed-off-by line at the end of the commit message. Add Signed-off-by line at the end of the commit message.
-v:: -v|--verify::
Look for suspicious lines the commit introduces, and Look for suspicious lines the commit introduces, and
abort committing if there is one. The definition of abort committing if there is one. The definition of
'suspicious lines' is currently the lines that has 'suspicious lines' is currently the lines that has
trailing whitespaces, and the lines whose indentation trailing whitespaces, and the lines whose indentation
has a SP character immediately followed by a TAB 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 The message taken from file with `-F`, command line with
`-m`, and from file with `-C` are usually used as the `-m`, and from file with `-C` are usually used as the
commit log message unmodified. This option lets you commit log message unmodified. This option lets you
further edit the message taken from these sources. further edit the message taken from these sources.
--::
Do not interpret any more arguments as options.
<file>...:: <file>...::
Update specified paths in the index file before committing. Update specified paths in the index file before committing.