summaryrefslogtreecommitdiff
path: root/Documentation/config/commit.adoc
blob: 208ae76c816f3b3113596289386d872ff590ed5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
ifdef::git-commit[]
:see-git-commit:
endif::git-commit[]
ifndef::git-commit[]
:see-git-commit: See linkgit:git-commit[1] for details.
endif::git-commit[]
`commit.cleanup`::
	This setting overrides the default of the `--cleanup` option in
	`git commit`. {see-git-commit} Changing the default can be useful
	when you always want to keep lines that begin
	with the comment character (`core.commentChar`, default `#`)
	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 the comment character
	in the commit log template yourself, if you do this).

`commit.gpgSign`::
	A boolean to specify whether all commits should be GPG signed.
	Use of this option when doing operations such as rebase can
	result in a large number of commits being signed. It may be
	convenient to use an agent to avoid typing your GPG passphrase
	several times.

`commit.status`::
	A boolean to enable/disable inclusion of status information in the
	commit message template when using an editor to prepare the commit
	message.  Defaults to `true`.

`commit.template`::
	Specify the pathname of a file to use as the template for
	new commit messages.

`commit.verbose`::
	A boolean or int to specify the level of verbosity with `git commit`.
	{see-git-commit}