summaryrefslogtreecommitdiffstats
path: root/git-commit.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-03-21 15:49:01 -0700
committerJunio C Hamano <gitster@pobox.com>2013-03-21 15:49:01 -0700
commit5e7f131ec750093b9c1691ff92db43b0595ea98c (patch)
tree336c153c1aecfeab7cab7cf3502a7ffe0a6d7d6f /git-commit.txt
parent947ab826679af3ad71f1bd69391deca3bc6edad9 (diff)
downloadgit-htmldocs-5e7f131ec750093b9c1691ff92db43b0595ea98c.tar.gz
Autogenerated HTML docs for v1.8.2-135-g7b592
Diffstat (limited to 'git-commit.txt')
-rw-r--r--git-commit.txt29
1 files changed, 19 insertions, 10 deletions
diff --git a/git-commit.txt b/git-commit.txt
index 0eb79ccdb..24a99ccc9 100644
--- a/git-commit.txt
+++ b/git-commit.txt
@@ -172,16 +172,25 @@ OPTIONS
linkgit:git-commit-tree[1].
--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. The default
- can be changed by the 'commit.cleanup' configuration variable
- (see linkgit:git-config[1]).
+ This option determines how the supplied commit message should be
+ cleaned up before committing. The '<mode>' can be `strip`,
+ `whitespace`, `verbatim`, or `default`.
++
+--
+strip::
+ Strip leading and trailing empty lines, trailing whitespace, and
+ #commentary and collapse consecutive empty lines.
+whitespace::
+ Same as `strip` except #commentary is not removed.
+verbatim::
+ Do not change the message at all.
+default::
+ Same as `strip` if the message is to be edited.
+ Otherwise `whitespace`.
+--
++
+The default can be changed by the 'commit.cleanup' configuration
+variable (see linkgit:git-config[1]).
-e::
--edit::