Merge branches 'lt/show' and 'lt/revlist'
[gitweb.git] / Documentation / git-commit.txt
index 790a8eb0ddf13146dde12bf944e998ef778bde5a..72f96fcfd53d836a8c62d51540762d48d6649863 100644 (file)
@@ -1,6 +1,5 @@
 git-commit(1)
 =============
-v0.99.4, Aug 2005
 
 NAME
 ----
@@ -8,7 +7,9 @@ git-commit - Record your changes
 
 SYNOPSIS
 --------
-'git commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...
+[verse]
+'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
+          [-e] [--] <file>...
 
 DESCRIPTION
 -----------
@@ -23,8 +24,10 @@ information.
 
 OPTIONS
 -------
--a::
-       Update all paths in the index file.
+-a|--all::
+       Update all paths in the index file.  This flag notices
+       files that have been modified and deleted, but new files
+       you have not told git about are not affected.
 
 -c or -C <commit>::
        Take existing commit object, and reuse the log message
@@ -40,27 +43,37 @@ 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.
 
 
+If you make a commit and then found a mistake immediately after
+that, you can recover from it with gitlink:git-reset[1].
+
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org> and