Documentation/git-commit.txt: rework the --cleanup section
Signed-off-by: Brandon Casey <drafnel@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Brandon Casey committed
Feb 19, 2013 at 10:14 UTC
46fbf7536404257a68fd4ea5d92a3bcb3f7b5848
1 file changed
+19
-10
Documentation/git-commit.txt
+19
-10
@@ -172,16 +172,25 @@ OPTIONS
172
linkgit:git-commit-tree[1].
173
174
--cleanup=<mode>::
175
- This option sets how the commit message is cleaned up.
176
- The '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
177
- and 'default'. The 'default' mode will strip leading and
178
- trailing empty lines and #commentary from the commit message
179
- only if the message is to be edited. Otherwise only whitespace
180
- removed. The 'verbatim' mode does not change message at all,
181
- 'whitespace' removes just leading/trailing whitespace lines
182
- and 'strip' removes both whitespace and commentary. The default
183
- can be changed by the 'commit.cleanup' configuration variable
184
- (see linkgit:git-config[1]).
175
+ This option determines how the supplied commit message should be
176
+ cleaned up before committing. The '<mode>' can be `strip`,
177
+ `whitespace`, `verbatim`, or `default`.
178
++
179
+--
180
+strip::
181
+ Strip leading and trailing empty lines, trailing whitespace, and
182
+ #commentary and collapse consecutive empty lines.
183
+whitespace::
184
+ Same as `strip` except #commentary is not removed.
185
+verbatim::
186
+ Do not change the message at all.
187
+default::
188
+ Same as `strip` if the message is to be edited.
189
+ Otherwise `whitespace`.
190
+--
191
++
192
+The default can be changed by the 'commit.cleanup' configuration
193
+variable (see linkgit:git-config[1]).
194
195
-e::
196
--edit::