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 8/9] doc: git-log: convert diff options to new doc format
Date: Mon, 07 Jul 2025 18:53:31 +0000	[thread overview]
Message-ID: <207fc49a20111109ef18fcf2ae6d3060312a8aa9.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.
- In description lists, put each option on its own line, to make them more
searchable and enable automatic translation of the options.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/diff-options.adoc | 40 +++++++++++++++++++--------------
 1 file changed, 23 insertions(+), 17 deletions(-)

diff --git a/Documentation/diff-options.adoc b/Documentation/diff-options.adoc
index 640eb6e7db58..f3a35d81411f 100644
--- a/Documentation/diff-options.adoc
+++ b/Documentation/diff-options.adoc
@@ -37,32 +37,32 @@ endif::git-diff[]
 endif::git-format-patch[]
 
 ifdef::git-log[]
--m::
+`-m`::
 	Show diffs for merge commits in the default format. This is
 	similar to `--diff-merges=on`, except `-m` will
 	produce no output unless `-p` is given as well.
 
--c::
+`-c`::
 	Produce combined diff output for merge commits.
 	Shortcut for `--diff-merges=combined -p`.
 
---cc::
+`--cc`::
 	Produce dense combined diff output for merge commits.
 	Shortcut for `--diff-merges=dense-combined -p`.
 
---dd::
+`--dd`::
 	Produce diff with respect to first parent for both merge and
 	regular commits.
 	Shortcut for `--diff-merges=first-parent -p`.
 
---remerge-diff::
+`--remerge-diff`::
 	Produce remerge-diff output for merge commits.
 	Shortcut for `--diff-merges=remerge -p`.
 
---no-diff-merges::
+`--no-diff-merges`::
 	Synonym for `--diff-merges=off`.
 
---diff-merges=<format>::
+`--diff-merges=<format>`::
 	Specify diff format to be used for merge commits. Default is
 	{diff-merges-default} unless `--first-parent` is in use, in
 	which case `first-parent` is the default.
@@ -70,48 +70,54 @@ ifdef::git-log[]
 The following formats are supported:
 +
 --
-off, none::
+`off`::
+`none`::
 	Disable output of diffs for merge commits. Useful to override
 	implied value.
 
-on, m::
+`on`::
+`m`::
 	Make diff output for merge commits to be shown in the default
 	format. The default format can be changed using
 	`log.diffMerges` configuration variable, whose default value
 	is `separate`.
 
-first-parent, 1::
+`first-parent`::
+`1`::
 	Show full diff with respect to first parent. This is the same
 	format as `--patch` produces for non-merge commits.
 
-separate::
+`separate`::
 	Show full diff with respect to each of parents.
 	Separate log entry and diff is generated for each parent.
 
-combined, c::
+`combined`::
+`c`::
 	Show differences from each of the parents to the merge
 	result simultaneously instead of showing pairwise diff between
 	a parent and the result one at a time. Furthermore, it lists
 	only files which were modified from all parents.
 
-dense-combined, cc::
+`dense-combined`::
+`cc`::
 	Further compress output produced by `--diff-merges=combined`
 	by omitting uninteresting hunks whose contents in the parents
 	have only two variants and the merge result picks one of them
 	without modification.
 
-remerge, r::
-	Remerge two-parent merge commits to create a temporary tree
+`remerge`::
+`r`:: Remerge two-parent merge commits to create a temporary tree
 	object--potentially containing files with conflict markers
 	and such.  A diff is then shown between that temporary tree
 	and the actual merge commit.
+--
 +
 The output emitted when this option is used is subject to change, and
 so is its interaction with other options (unless explicitly
 documented).
---
 
---combined-all-paths::
+
+`--combined-all-paths`::
 	Cause combined diffs (used for merge commits) to
 	list the name of the file from all parents.  It thus only has
 	effect when `--diff-merges=[dense-]combined` is in use, and
-- 
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     ` Jean-Noël Avila via GitGitGadget [this message]
2025-07-07 18:53     ` [PATCH v3 9/9] doc: git-log: convert log config to new doc format Jean-Noël Avila via GitGitGadget
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=207fc49a20111109ef18fcf2ae6d3060312a8aa9.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).