Skip to contentSkip to conversation

doc: log: fix --decorate description list

PATCH In review [email protected] 2 participants 4 messages Apr 27 – May 12 Documentation

lore
Share & tools
lore
#0 lore raw

cover doc: log: fix --decorate description list

From: Kristoffer Haugsbakk <[email protected]>

Topic name: kh/doc-log-decorate-list

Topic summary: Fix formatting of the '--decorate' description list.

[1/2] doc: log: fix --decorate description list [2/2] doc: log: use the same delimiter in description list

 Documentation/git-log.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

base-commit: 67ad42147a7acc2af6074753ebd03d904476118f

Signature · 1 line
2.54.0.13.g9c7419e39f8
#1 lore raw

PATCH 1/2 doc: log: fix --decorate description list

From: Kristoffer Haugsbakk <[email protected]>

026f2e3b (doc: convert git-log to new documentation format, 2025-07-07) transformed the inline description of --decorate options to a description list:

We also transform inline descriptions of possible values of option --decorate into a list, which is more readable and extensible.

But a source code block was used instead of an open block.

---
 Documentation/git-log.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/git-log.adoc +2 -2
index e304739c5e8..1c95499060d 100644
@@ -36,14 +36,14 @@ OPTIONS
 	Print out the ref names of any commits that are shown. 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) is 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.
-----
+--
 +
 The option `--decorate` is short-hand for `--decorate=short`. Default to
 configuration value of `log.decorate` if configured, otherwise, `auto`.
Signature · 1 line
2.54.0.13.g9c7419e39f8
#2 lore raw

PATCH 2/2 doc: log: use the same delimiter in description list

In reply to [email protected]

From: Kristoffer Haugsbakk <[email protected]>

We must use the same delimiter since this is a meant to be a flat list. Introducing a new legal delimiter like :: makes an inner description list:

...
full
the full ref name ...

auto
if the output ...

---
 Documentation/git-log.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-log.adoc +1 -1
index 1c95499060d..fb3ac112839 100644
@@ -40,7 +40,7 @@ OPTIONS
 `short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
 	`refs/remotes/` are not printed.
 `full`;; the full ref name (including prefix) is printed.
-`auto`:: if the output is going to a terminal, the ref names
+`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.
 --
Signature · 1 line
2.54.0.13.g9c7419e39f8
#3 lore raw
In reply to [email protected]
Quoted 6 lines · [email protected] writes:

From: Kristoffer Haugsbakk <[email protected]>

Topic name: kh/doc-log-decorate-list

Topic summary: Fix formatting of the '--decorate' description list.

Quoted 8 lines

[1/2] doc: log: fix --decorate description list [2/2] doc: log: use the same delimiter in description list

 Documentation/git-log.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

base-commit: 67ad42147a7acc2af6074753ebd03d904476118f

This does give us a solid improvement. Let me mark the topic for 'next'.

Thanks.