GIT 1.5.4-rc2
[gitweb.git] / Documentation / git-commit.txt
index 4261384158f53ebe85dc32148b5652dc697e5b3b..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
 -----------
@@ -95,6 +95,16 @@ OPTIONS
        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
        `-m`, and from file with `-C` are usually used as the