Skip to content

Commit 5b70fa1

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 <jn.avila@free.fr>
1 parent a8422aa commit 5b70fa1

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

Documentation/config/log.adoc

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,69 @@
1-
log.abbrevCommit::
1+
`log.abbrevCommit`::
22
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
33
linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
44
override this option with `--no-abbrev-commit`.
55

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
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
99
`--date` option. See linkgit:git-log[1] for details.
1010
+
1111
If the format is set to "auto:foo" and the pager is in use, format
1212
"foo" will be used for the date format. Otherwise, "default" will
1313
be used.
1414
15-
log.decorate::
15+
`log.decorate`::
1616
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`.
17+
command. Possible values are:
18+
+
19+
----
20+
`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
21+
`refs/remotes/` are not printed.
22+
`full`;; the full ref name (including prefix) are printed.
23+
`auto`;; if the output is going to a terminal,
24+
the ref names are shown as if `short` were given, otherwise no ref
25+
names are shown.
26+
----
27+
+
28+
This is the same as the `--decorate` option of the `git log`.
2429
25-
log.initialDecorationSet::
30+
`log.initialDecorationSet`::
2631
By default, `git log` only shows decorations for certain known ref
2732
namespaces. If 'all' is specified, then show all refs as
2833
decorations.
2934

30-
log.excludeDecoration::
35+
`log.excludeDecoration`::
3136
Exclude the specified patterns from the log decorations. This is
3237
similar to the `--decorate-refs-exclude` command-line option, but
3338
the config option can be overridden by the `--decorate-refs`
3439
option.
3540

36-
log.diffMerges::
41+
`log.diffMerges`::
3742
Set diff format to be used when `--diff-merges=on` is
3843
specified, see `--diff-merges` in linkgit:git-log[1] for
3944
details. Defaults to `separate`.
4045

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

47-
log.graphColors::
52+
`log.graphColors`::
4853
A list of colors, separated by commas, that can be used to draw
4954
history lines in `git log --graph`.
5055

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

57-
log.showSignature::
62+
`log.showSignature`::
5863
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
5964
linkgit:git-whatchanged[1] assume `--show-signature`.
6065

61-
log.mailmap::
66+
`log.mailmap`::
6267
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
6368
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
6469
assume `--no-use-mailmap`. True by default.

0 commit comments

Comments
 (0)