summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorRalf Thielow <ralf.thielow@gmail.com>2013-01-10 18:45:59 +0100
committerJunio C Hamano <gitster@pobox.com>2013-01-10 11:45:02 -0800
commit51fb3a3dfa4ffeeb210fb0e7d6f631503a5a1dfb (patch)
tree17e4f55ceaa5af76c77f41f51cb46f801657fdff /Documentation
parent44fe83502edf5391bb3a5997cab01794b4568062 (diff)
downloadgit-51fb3a3dfa4ffeeb210fb0e7d6f631503a5a1dfb.tar.gz
commit: make default of "cleanup" option configurable
The default of the "cleanup" option in "git commit" is not configurable. Users who don't want to use the default have to pass this option on every commit since there's no way to configure it. This commit introduces a new config option "commit.cleanup" which can be used to change the default of the "cleanup" option in "git commit". Signed-off-by: Ralf Thielow <ralf.thielow@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/config.txt9
-rw-r--r--Documentation/git-commit.txt4
2 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index d5809e0e8c..8f0ce9eae4 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -923,6 +923,15 @@ column.tag::
Specify whether to output tag listing in `git tag` in columns.
See `column.ui` for details.
+commit.cleanup::
+ This setting overrides the default of the `--cleanup` option in
+ `git commit`. See linkgit:git-commit[1] for details. Changing the
+ default can be useful when you always want to keep lines that begin
+ with comment character `#` in your log message, in which case you
+ would do `git config commit.cleanup whitespace` (note that you will
+ have to remove the help lines that begin with `#` in the commit log
+ template yourself, if you do this).
+
commit.status::
A boolean to enable/disable inclusion of status information in the
commit message template when using an editor to prepare the commit
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 7bdb039d5e..41b27da325 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -179,7 +179,9 @@ OPTIONS
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.
+ and 'strip' removes both whitespace and commentary. The default
+ can be changed by the 'commit.cleanup' configuration variable
+ (see linkgit:git-config[1]).
-e::
--edit::