GIT 1.5.4-rc2
[gitweb.git] / Documentation / git-commit.txt
index a7ef71ff99ced2f973d8e4c857d49e75ec65a908..96383b6543c781090bc2d4d7cf215c645b08714b 100644 (file)
@@ -11,7 +11,7 @@ SYNOPSIS
 'git-commit' [-a | --interactive] [-s] [-v] [-u]
           [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
           [--allow-empty] [--no-verify] [-e] [--author <author>]
-          [--] [[-i | -o ]<file>...]
+          [--cleanup=<mode>] [--] [[-i | -o ]<file>...]
 
 DESCRIPTION
 -----------
@@ -86,14 +86,24 @@ OPTIONS
        Add Signed-off-by line at the end of the commit message.
 
 --no-verify::
-       This option bypasses the pre-commit hook.
+       This option bypasses the pre-commit and commit-msg hooks.
        See also link:hooks.html[hooks].
 
 --allow-empty::
        Usually recording a commit that has the exact same tree as its
-       sole parent commit and the command prevents you from making such
-       a mistake.  This option bypasses the safety, and is primarily
-       for use by foreign scm interface scripts.
+       sole parent commit is a mistake, and the command prevents you
+       from making such a commit.  This option bypasses the safety, and
+       is primarily for use by foreign scm interface scripts.
+
+--cleanup=<mode>::
+       This option sets how the commit message is cleaned up.
+       The  '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
+       and 'default'. The 'default' mode will strip leading and
+       trailing empty lines and #commentary from the commit message
+       only if the message is to be edited. Otherwise only whitespace
+       removed. The 'verbatim' mode does not change message at all,
+       'whitespace' removes just leading/trailing whitespace lines
+       and 'strip' removes both whitespace and commentary.
 
 -e|--edit::
        The message taken from file with `-F`, command line with