diff options
author | Junio C Hamano <gitster@pobox.com> | 2013-04-03 09:26:07 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2013-04-03 09:26:07 -0700 |
commit | 14c79b1faa113707d8955912af6064d9844f71eb (patch) | |
tree | 0072f315d261bf4c4792ddcba45445facab1e0d1 /Documentation | |
parent | Merge branch 'jc/describe' into maint (diff) | |
parent | Documentation/git-commit.txt: rework the --cleanup section (diff) | |
download | tgif-14c79b1faa113707d8955912af6064d9844f71eb.tar.xz |
Merge branch 'bc/commit-complete-lines-given-via-m-option' into maint
'git commit -m "$msg"' used to add an extra newline even when
$msg already ended with one.
* bc/commit-complete-lines-given-via-m-option:
Documentation/git-commit.txt: rework the --cleanup section
git-commit: only append a newline to -m mesg if necessary
t7502: demonstrate breakage with a commit message with trailing newlines
t/t7502: compare entire commit message with what was expected
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-commit.txt | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 42c22bb59d..05f8297368 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -174,16 +174,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:: |