summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2007-12-26 17:35:38 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2007-12-26 17:35:38 -0800
commit97d0c52980f0e64f0feed5b31390a32561df0ecf (patch)
treeec72aea1584b88cc846f5b39c12d530b354dcd67 /Documentation
parentFix rewrite_diff() name quoting. (diff)
parentAllow selection of different cleanup modes for commit messages (diff)
downloadtgif-97d0c52980f0e64f0feed5b31390a32561df0ecf.tar.xz
Merge branch 'ar/commit-cleanup'
* ar/commit-cleanup: Allow selection of different cleanup modes for commit messages builtin-commit: avoid double-negation in the code. builtin-commit: fix amending of the initial commit t7005: do not exit inside test.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-commit.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 4261384158..96383b6543 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -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