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>main
parent
0b4ccb2199
commit
b27be108c8
|
@ -1,64 +1,76 @@
|
||||||
log.abbrevCommit::
|
`log.abbrevCommit`::
|
||||||
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
If `true`, make
|
||||||
linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
|
ifndef::with-breaking-changes[]
|
||||||
|
linkgit:git-log[1], linkgit:git-show[1], and
|
||||||
|
linkgit:git-whatchanged[1]
|
||||||
|
endif::with-breaking-changes[]
|
||||||
|
ifdef::with-breaking-changes[]
|
||||||
|
linkgit:git-log[1] and linkgit:git-show[1]
|
||||||
|
endif::with-breaking-changes[]
|
||||||
|
assume `--abbrev-commit`. You may
|
||||||
override this option with `--no-abbrev-commit`.
|
override this option with `--no-abbrev-commit`.
|
||||||
|
|
||||||
log.date::
|
`log.date`::
|
||||||
Set the default date-time mode for the 'log' command.
|
Set the default date-time mode for the `log` command.
|
||||||
Setting a value for log.date is similar to using 'git log''s
|
Setting a value for log.date is similar to using `git log`'s
|
||||||
`--date` option. See linkgit:git-log[1] for details.
|
`--date` option. See linkgit:git-log[1] for details.
|
||||||
+
|
+
|
||||||
If the format is set to "auto:foo" and the pager is in use, format
|
If the format is set to "auto:foo" and the pager is in use, format
|
||||||
"foo" will be used for the date format. Otherwise, "default" will
|
"foo" will be used for the date format. Otherwise, "default" will
|
||||||
be used.
|
be used.
|
||||||
|
|
||||||
log.decorate::
|
`log.decorate`::
|
||||||
Print out the ref names of any commits that are shown by the log
|
Print out the ref names of any commits that are shown by the log
|
||||||
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
|
command. Possible values are:
|
||||||
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
|
+
|
||||||
specified, the full ref name (including prefix) will be printed.
|
----
|
||||||
If 'auto' is specified, then if the output is going to a terminal,
|
`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
|
||||||
the ref names are shown as if 'short' were given, otherwise no ref
|
`refs/remotes/` are not printed.
|
||||||
names are shown. This is the same as the `--decorate` option
|
`full`;; the full ref name (including prefix) are printed.
|
||||||
of the `git log`.
|
`auto`;; if the output is going to a terminal,
|
||||||
|
the ref names are shown as if `short` were given, otherwise no ref
|
||||||
|
names are shown.
|
||||||
|
----
|
||||||
|
+
|
||||||
|
This is the same as the `--decorate` option of the `git log`.
|
||||||
|
|
||||||
log.initialDecorationSet::
|
`log.initialDecorationSet`::
|
||||||
By default, `git log` only shows decorations for certain known ref
|
By default, `git log` only shows decorations for certain known ref
|
||||||
namespaces. If 'all' is specified, then show all refs as
|
namespaces. If 'all' is specified, then show all refs as
|
||||||
decorations.
|
decorations.
|
||||||
|
|
||||||
log.excludeDecoration::
|
`log.excludeDecoration`::
|
||||||
Exclude the specified patterns from the log decorations. This is
|
Exclude the specified patterns from the log decorations. This is
|
||||||
similar to the `--decorate-refs-exclude` command-line option, but
|
similar to the `--decorate-refs-exclude` command-line option, but
|
||||||
the config option can be overridden by the `--decorate-refs`
|
the config option can be overridden by the `--decorate-refs`
|
||||||
option.
|
option.
|
||||||
|
|
||||||
log.diffMerges::
|
`log.diffMerges`::
|
||||||
Set diff format to be used when `--diff-merges=on` is
|
Set diff format to be used when `--diff-merges=on` is
|
||||||
specified, see `--diff-merges` in linkgit:git-log[1] for
|
specified, see `--diff-merges` in linkgit:git-log[1] for
|
||||||
details. Defaults to `separate`.
|
details. Defaults to `separate`.
|
||||||
|
|
||||||
log.follow::
|
`log.follow`::
|
||||||
If `true`, `git log` will act as if the `--follow` option was used when
|
If `true`, `git log` will act as if the `--follow` option was used when
|
||||||
a single <path> is given. This has the same limitations as `--follow`,
|
a single <path> is given. This has the same limitations as `--follow`,
|
||||||
i.e. it cannot be used to follow multiple files and does not work well
|
i.e. it cannot be used to follow multiple files and does not work well
|
||||||
on non-linear history.
|
on non-linear history.
|
||||||
|
|
||||||
log.graphColors::
|
`log.graphColors`::
|
||||||
A list of colors, separated by commas, that can be used to draw
|
A list of colors, separated by commas, that can be used to draw
|
||||||
history lines in `git log --graph`.
|
history lines in `git log --graph`.
|
||||||
|
|
||||||
log.showRoot::
|
`log.showRoot`::
|
||||||
If true, the initial commit will be shown as a big creation event.
|
If true, the initial commit will be shown as a big creation event.
|
||||||
This is equivalent to a diff against an empty tree.
|
This is equivalent to a diff against an empty tree.
|
||||||
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
|
Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
|
||||||
normally hide the root commit will now show it. True by default.
|
normally hide the root commit will now show it. True by default.
|
||||||
|
|
||||||
log.showSignature::
|
`log.showSignature`::
|
||||||
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
||||||
linkgit:git-whatchanged[1] assume `--show-signature`.
|
linkgit:git-whatchanged[1] assume `--show-signature`.
|
||||||
|
|
||||||
log.mailmap::
|
`log.mailmap`::
|
||||||
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
If true, makes linkgit:git-log[1], linkgit:git-show[1], and
|
||||||
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
|
linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
|
||||||
assume `--no-use-mailmap`. True by default.
|
assume `--no-use-mailmap`. True by default.
|
||||||
|
|
Loading…
Reference in New Issue