From 31d19899c7a0e08e8cf843ea1abe7504eb3a1d34 Mon Sep 17 00:00:00 2001 From: Kristoffer Haugsbakk Date: Mon, 27 Apr 2026 21:06:49 +0200 Subject: [PATCH 1/2] doc: log: fix --decorate description list 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. Signed-off-by: Kristoffer Haugsbakk Signed-off-by: Junio C Hamano --- Documentation/git-log.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-log.adoc b/Documentation/git-log.adoc index e304739c5e..1c95499060 100644 --- a/Documentation/git-log.adoc +++ b/Documentation/git-log.adoc @@ -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`. From b635fd0725dd74ae59a0467a3180624a8e9abdb0 Mon Sep 17 00:00:00 2001 From: Kristoffer Haugsbakk Date: Mon, 27 Apr 2026 21:06:50 +0200 Subject: [PATCH 2/2] doc: log: use the same delimiter in description list 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 ... Signed-off-by: Kristoffer Haugsbakk Signed-off-by: Junio C Hamano --- Documentation/git-log.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-log.adoc b/Documentation/git-log.adoc index 1c95499060..fb3ac11283 100644 --- a/Documentation/git-log.adoc +++ b/Documentation/git-log.adoc @@ -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. --