doc: convert git commit config to new format
Also prevent git-commit manpage to refer to itself in the config description by using a variable. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Jan 15, 2025 at 20:23 UTC
819fdd6e76d6dbd3410e9614be843cd50f8a6c75
1 file changed
+15
-10
Documentation/config/commit.txt
+15
-10
@@ -1,29 +1,34 @@
1
-commit.cleanup::
1
+ifdef::git-commit[]
2
+:see-git-commit:
3
+endif::git-commit[]
4
+ifndef::git-commit[]
5
+:see-git-commit: See linkgit:git-commit[1] for details.
6
+endif::git-commit[]
7
+`commit.cleanup`::
8
This setting overrides the default of the `--cleanup` option in
3
- `git commit`. See linkgit:git-commit[1] for details. Changing the
4
- default can be useful when you always want to keep lines that begin
9
+ `git commit`. {see-git-commit} Changing the default can be useful
10
+ when you always want to keep lines that begin
11
with the comment character `#` in your log message, in which case you
12
would do `git config commit.cleanup whitespace` (note that you will
13
have to remove the help lines that begin with `#` in the commit log
14
template yourself, if you do this).
15
10
-commit.gpgSign::
11
-
16
+`commit.gpgSign`::
17
A boolean to specify whether all commits should be GPG signed.
18
Use of this option when doing operations such as rebase can
19
result in a large number of commits being signed. It may be
20
convenient to use an agent to avoid typing your GPG passphrase
21
several times.
22
18
-commit.status::
23
+`commit.status`::
24
A boolean to enable/disable inclusion of status information in the
25
commit message template when using an editor to prepare the commit
21
- message. Defaults to true.
26
+ message. Defaults to `true`.
27
23
-commit.template::
28
+`commit.template`::
29
Specify the pathname of a file to use as the template for
30
new commit messages.
31
27
-commit.verbose::
32
+`commit.verbose`::
33
A boolean or int to specify the level of verbosity with `git commit`.
29
- See linkgit:git-commit[1].
34
+ {see-git-commit}