]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: git-log: convert log config to new doc format
authorJean-Noël Avila <jn.avila@free.fr>
Sun, 8 Jun 2025 09:09:46 +0000 (09:09 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 8 Jun 2025 16:22:28 +0000 (09:22 -0700)
- 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>
Documentation/config/log.adoc

index 9003a8219143ab75524391303df2f88ca8922e86..210439f2b641286c0b6f65a7b954b85cf051aaa9 100644 (file)
@@ -1,64 +1,69 @@
-log.abbrevCommit::
+`log.abbrevCommit`::
        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
        override this option with `--no-abbrev-commit`.
 
-log.date::
-       Set the default date-time mode for the 'log' command.
-       Setting a value for log.date is similar to using 'git log''s
+`log.date`::
+       Set the default date-time mode for the `log` command.
+       Setting a value for log.date is similar to using `git log`'s
        `--date` option.  See linkgit:git-log[1] for details.
 +
 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
 be used.
 
-log.decorate::
+`log.decorate`::
        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/',
-       '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,
-       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`.
+       command. Possible values are:
++
+----
+`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
+       `refs/remotes/` are not printed.
+`full`;; the full ref name (including prefix) are printed.
+`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
        namespaces. If 'all' is specified, then show all refs as
        decorations.
 
-log.excludeDecoration::
+`log.excludeDecoration`::
        Exclude the specified patterns from the log decorations. This is
        similar to the `--decorate-refs-exclude` command-line option, but
        the config option can be overridden by the `--decorate-refs`
        option.
 
-log.diffMerges::
+`log.diffMerges`::
        Set diff format to be used when `--diff-merges=on` is
        specified, see `--diff-merges` in linkgit:git-log[1] for
        details. Defaults to `separate`.
 
-log.follow::
+`log.follow`::
        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`,
        i.e. it cannot be used to follow multiple files and does not work well
        on non-linear history.
 
-log.graphColors::
+`log.graphColors`::
        A list of colors, separated by commas, that can be used to draw
        history lines in `git log --graph`.
 
-log.showRoot::
+`log.showRoot`::
        If true, the initial commit will be shown as a big creation event.
        This is equivalent to a diff against an empty tree.
        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
        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
        linkgit:git-whatchanged[1] assume `--show-signature`.
 
-log.mailmap::
+`log.mailmap`::
        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
        linkgit:git-whatchanged[1] assume `--use-mailmap`, otherwise
        assume `--no-use-mailmap`. True by default.