git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>,
	"Jean-Noël Avila" <jn.avila@free.fr>,
	"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v3 9/9] doc: git-log: convert log config to new doc format
Date: Mon, 07 Jul 2025 18:53:32 +0000	[thread overview]
Message-ID: <b51d362196458d18394579207bbdf8a01ea56ac3.1751914412.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1933.v3.git.1751914412.gitgitgadget@gmail.com>

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

- 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>
---
 Documentation/config/log.adoc | 47 +++++++++++++++++++----------------
 1 file changed, 26 insertions(+), 21 deletions(-)

diff --git a/Documentation/config/log.adoc b/Documentation/config/log.adoc
index a9b160e7dee4..16e00e8d296a 100644
--- a/Documentation/config/log.adoc
+++ b/Documentation/config/log.adoc
@@ -1,5 +1,5 @@
-log.abbrevCommit::
-	If true, makes
+`log.abbrevCommit`::
+	If `true`, make
 ifndef::with-breaking-changes[]
 	linkgit:git-log[1], linkgit:git-show[1], and
 	linkgit:git-whatchanged[1]
@@ -10,62 +10,67 @@ endif::with-breaking-changes[]
 	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.
-- 
gitgitgadget

  parent reply	other threads:[~2025-07-07 18:53 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-08  9:09 [PATCH 0/9] Doc git log Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-06-16 23:02   ` Junio C Hamano
2025-06-19 20:51     ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-06-19  1:24   ` Junio C Hamano
2025-06-19 20:55     ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-07-04 20:43   ` Kristoffer Haugsbakk
2025-07-04 21:39     ` Kristoffer Haugsbakk
2025-07-06 15:07       ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 8/9] doc: git-log: convert diff options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 9/9] doc: git-log: convert log config " Jean-Noël Avila via GitGitGadget
2025-06-18 21:35 ` [PATCH 0/9] Doc git log Junio C Hamano
2025-07-06 15:27   ` Jean-Noël AVILA
2025-06-29 13:20 ` [PATCH v2 0/9] doc: convert git log man page to new synopsis format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-07-04 20:31     ` Kristoffer Haugsbakk
2025-06-29 13:20   ` [PATCH v2 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 8/9] doc: git-log: convert diff options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 9/9] doc: git-log: convert log config " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53   ` [PATCH v3 0/9] doc: convert git log man page to new synopsis format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-08-17 21:29       ` SZEDER Gábor
2025-08-19 21:22         ` [PATCH] doc: fix asciidoc format compatibility in pretty-formats.adoc Jean-Noël Avila
2025-08-19 21:49           ` Junio C Hamano
2025-08-20 20:26             ` [PATCH v2] " Jean-Noël Avila
2025-08-20 20:26               ` Jean-Noël Avila
2025-08-20 21:03               ` Junio C Hamano
2025-08-20 21:00             ` [PATCH] " Jean-Noël AVILA
2025-08-20 21:23         ` [PATCH v3] " Jean-Noël Avila
2025-07-07 18:53     ` [PATCH v3 8/9] doc: git-log: convert diff options to new doc format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` Jean-Noël Avila via GitGitGadget [this message]
2025-07-07 20:59     ` [PATCH v3 0/9] doc: convert git log man page to new synopsis format Junio C Hamano
2025-07-07 21:01       ` Jean-Noël AVILA

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b51d362196458d18394579207bbdf8a01ea56ac3.1751914412.git.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    --cc=kristofferhaugsbakk@fastmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).