Skip to content

Commit b27be10

Browse files
jnavilagitster
authored andcommitted
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]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0b4ccb2 commit b27be10

File tree

1 file changed

+34
-22
lines changed

1 file changed

+34
-22
lines changed

Documentation/config/log.adoc

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -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
411
override this option with `--no-abbrev-commit`.
512

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
916
`--date` option. See linkgit:git-log[1] for details.
1017
+
1118
If the format is set to "auto:foo" and the pager is in use, format
1219
"foo" will be used for the date format. Otherwise, "default" will
1320
be used.
1421
15-
log.decorate::
22+
`log.decorate`::
1623
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`.
2436
25-
log.initialDecorationSet::
37+
`log.initialDecorationSet`::
2638
By default, `git log` only shows decorations for certain known ref
2739
namespaces. If 'all' is specified, then show all refs as
2840
decorations.
2941

30-
log.excludeDecoration::
42+
`log.excludeDecoration`::
3143
Exclude the specified patterns from the log decorations. This is
3244
similar to the `--decorate-refs-exclude` command-line option, but
3345
the config option can be overridden by the `--decorate-refs`
3446
option.
3547

36-
log.diffMerges::
48+
`log.diffMerges`::
3749
Set diff format to be used when `--diff-merges=on` is
3850
specified, see `--diff-merges` in linkgit:git-log[1] for
3951
details. Defaults to `separate`.
4052

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

47-
log.graphColors::
59+
`log.graphColors`::
4860
A list of colors, separated by commas, that can be used to draw
4961
history lines in `git log --graph`.
5062

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

57-
log.showSignature::
69+
`log.showSignature`::
5870
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
5971
linkgit:git-whatchanged[1] assume `--show-signature`.
6072

61-
log.mailmap::
73+
`log.mailmap`::
6274
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6375
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
6476
assume `--no-use-mailmap`. True by default.

0 commit comments

Comments
 (0)