doc: git-log: convert log config to new doc format
- Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. - Explain possible options in description list instead of in a paragraph. 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
Jul 7, 2025 at 18:53 UTC
b27be108c89cc57ce068719a82266020436a478b
1 file changed
+34
-22
Documentation/config/log.adoc
+34
-22
@@ -1,64 +1,76 @@
1
-log.abbrevCommit::
2
- If true, makes linkgit:git-log[1], linkgit:git-show[1], and
3
- linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1
+`log.abbrevCommit`::
2
+ If `true`, make
3
+ifndef::with-breaking-changes[]
4
+ linkgit:git-log[1], linkgit:git-show[1], and
5
+ linkgit:git-whatchanged[1]
6
+endif::with-breaking-changes[]
7
+ifdef::with-breaking-changes[]
8
+ linkgit:git-log[1] and linkgit:git-show[1]
9
+endif::with-breaking-changes[]
10
+ assume `--abbrev-commit`. You may
11
override this option with `--no-abbrev-commit`.
12
6
-log.date::
7
- Set the default date-time mode for the 'log' command.
8
- Setting a value for log.date is similar to using 'git log''s
13
+`log.date`::
14
+ Set the default date-time mode for the `log` command.
15
+ Setting a value for log.date is similar to using `git log`'s
16
`--date` option. See linkgit:git-log[1] for details.
17
+
18
If the format is set to "auto:foo" and the pager is in use, format
19
"foo" will be used for the date format. Otherwise, "default" will
20
be used.
21
15
-log.decorate::
22
+`log.decorate`::
23
Print out the ref names of any commits that are shown by the log
17
- command. If 'short' is specified, the ref name prefixes 'refs/heads/',
18
- 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
19
- specified, the full ref name (including prefix) will be printed.
20
- If 'auto' is specified, then if the output is going to a terminal,
21
- the ref names are shown as if 'short' were given, otherwise no ref
22
- names are shown. This is the same as the `--decorate` option
23
- of the `git log`.
24
+ command. Possible values are:
25
++
26
+----
27
+`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
28
+ `refs/remotes/` are not printed.
29
+`full`;; the full ref name (including prefix) are printed.
30
+`auto`;; if the output is going to a terminal,
31
+ the ref names are shown as if `short` were given, otherwise no ref
32
+ names are shown.
33
+----
34
++
35
+This is the same as the `--decorate` option of the `git log`.
36
25
-log.initialDecorationSet::
37
+`log.initialDecorationSet`::
38
By default, `git log` only shows decorations for certain known ref
39
namespaces. If 'all' is specified, then show all refs as
40
decorations.
41
30
-log.excludeDecoration::
42
+`log.excludeDecoration`::
43
Exclude the specified patterns from the log decorations. This is
44
similar to the `--decorate-refs-exclude` command-line option, but
45
the config option can be overridden by the `--decorate-refs`
46
option.
47
36
-log.diffMerges::
48
+`log.diffMerges`::
49
Set diff format to be used when `--diff-merges=on` is
50
specified, see `--diff-merges` in linkgit:git-log[1] for
51
details. Defaults to `separate`.
52
41
-log.follow::
53
+`log.follow`::
54
If `true`, `git log` will act as if the `--follow` option was used when
55
a single <path> is given. This has the same limitations as `--follow`,
56
i.e. it cannot be used to follow multiple files and does not work well
57
on non-linear history.
58
47
-log.graphColors::
59
+`log.graphColors`::
60
A list of colors, separated by commas, that can be used to draw
61
history lines in `git log --graph`.
62
51
-log.showRoot::
63
+`log.showRoot`::
64
If true, the initial commit will be shown as a big creation event.
65
This is equivalent to a diff against an empty tree.
66
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
67
normally hide the root commit will now show it. True by default.
68
57
-log.showSignature::
69
+`log.showSignature`::
70
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
71
linkgit:git-whatchanged[1] assume `--show-signature`.
72
61
-log.mailmap::
73
+`log.mailmap`::
74
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
75
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
76
assume `--no-use-mailmap`. True by default.