[PATCH] Possible cleanups for local-pull.c

[git.git] / Documentation / git-commit-script.txt

diff --git a/Documentation/git-commit-script.txt b/Documentation/git-commit-script.txt
index bb559d7..faa1870 100644 (file)
--- a/Documentation/git-commit-script.txt
+++ b/Documentation/git-commit-script.txt
@@ -8,7 +8,7 @@ git-commit-script - Record your changes
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git commit' [-a] [(-c | -C) <commit> | -F <file> | -m <msg>] <file>...
+'git commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] <file>...

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -17,6 +17,10 @@ Updates the index file for given paths, or all modified files if
 VISUAL and EDITOR environment variables to edit the commit log
 message.
 
 VISUAL and EDITOR environment variables to edit the commit log
 message.
 

+This command can run `commit-msg`, `pre-commit`, and
+`post-commit` hooks.  See link:hooks.html[hooks] for more
+information.
+

 OPTIONS
 -------
 -a::
 OPTIONS
 -------
 -a::


@@ -36,13 +40,32 @@ OPTIONS
 -m <msg>::
        Use the given <msg> as the commit message.
 
 -m <msg>::
        Use the given <msg> as the commit message.
 

+-s::
+       Add Signed-off-by line at the end of the commit message.
+
+-v::
+       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.
+
+-e::
+       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.
+

 <file>...::
 <file>...::

-       Update specified paths in the index file.
+       Update specified paths in the index file before committing.

 
 
 Author
 ------
 
 
 Author
 ------

-Written by Linus Torvalds <torvalds@osdl.org>
+Written by Linus Torvalds <torvalds@osdl.org> and
+Junio C Hamano <junkio@cox.net>
+

 
 GIT
 ---
 
 GIT
 ---