Skip to content

Commit b51d362

Browse files
committed
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 <[email protected]>
1 parent 207fc49 commit b51d362

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

Documentation/config/log.adoc

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
log.abbrevCommit::
2-
If true, makes
1+
`log.abbrevCommit`::
2+
If `true`, make
33
ifndef::with-breaking-changes[]
44
linkgit:git-log[1], linkgit:git-show[1], and
55
linkgit:git-whatchanged[1]
@@ -10,62 +10,67 @@ endif::with-breaking-changes[]
1010
assume `--abbrev-commit`. You may
1111
override this option with `--no-abbrev-commit`.
1212

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
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
1616
`--date` option. See linkgit:git-log[1] for details.
1717
+
1818
If the format is set to "auto:foo" and the pager is in use, format
1919
"foo" will be used for the date format. Otherwise, "default" will
2020
be used.
2121
22-
log.decorate::
22+
`log.decorate`::
2323
Print out the ref names of any commits that are shown by the log
24-
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
25-
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
26-
specified, the full ref name (including prefix) will be printed.
27-
If 'auto' is specified, then if the output is going to a terminal,
28-
the ref names are shown as if 'short' were given, otherwise no ref
29-
names are shown. This is the same as the `--decorate` option
30-
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`.
3136
32-
log.initialDecorationSet::
37+
`log.initialDecorationSet`::
3338
By default, `git log` only shows decorations for certain known ref
3439
namespaces. If 'all' is specified, then show all refs as
3540
decorations.
3641

37-
log.excludeDecoration::
42+
`log.excludeDecoration`::
3843
Exclude the specified patterns from the log decorations. This is
3944
similar to the `--decorate-refs-exclude` command-line option, but
4045
the config option can be overridden by the `--decorate-refs`
4146
option.
4247

43-
log.diffMerges::
48+
`log.diffMerges`::
4449
Set diff format to be used when `--diff-merges=on` is
4550
specified, see `--diff-merges` in linkgit:git-log[1] for
4651
details. Defaults to `separate`.
4752

48-
log.follow::
53+
`log.follow`::
4954
If `true`, `git log` will act as if the `--follow` option was used when
5055
a single <path> is given. This has the same limitations as `--follow`,
5156
i.e. it cannot be used to follow multiple files and does not work well
5257
on non-linear history.
5358

54-
log.graphColors::
59+
`log.graphColors`::
5560
A list of colors, separated by commas, that can be used to draw
5661
history lines in `git log --graph`.
5762

58-
log.showRoot::
63+
`log.showRoot`::
5964
If true, the initial commit will be shown as a big creation event.
6065
This is equivalent to a diff against an empty tree.
6166
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
6267
normally hide the root commit will now show it. True by default.
6368

64-
log.showSignature::
69+
`log.showSignature`::
6570
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6671
linkgit:git-whatchanged[1] assume `--show-signature`.
6772

68-
log.mailmap::
73+
`log.mailmap`::
6974
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
7075
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
7176
assume `--no-use-mailmap`. True by default.

0 commit comments

Comments
 (0)