From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: "Kristoffer Haugsbakk" <code@khaugsbakk.name>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 1/2] doc: log: fix --decorate description list
Date: Mon, 27 Apr 2026 21:06:49 +0200 [thread overview]
Message-ID: <source_block_description_list.627@msgid.xyz> (raw)
In-Reply-To: <CV_doc_log_--decorate_list.626@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
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 <code@khaugsbakk.name>
---
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 e304739c5e8..1c95499060d 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`.
--
2.54.0.13.g9c7419e39f8
next prev parent reply other threads:[~2026-04-27 19:07 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-27 19:06 [PATCH 0/2] doc: log: fix --decorate description list kristofferhaugsbakk
2026-04-27 19:06 ` kristofferhaugsbakk [this message]
2026-04-27 19:06 ` [PATCH 2/2] doc: log: use the same delimiter in " kristofferhaugsbakk
2026-05-12 6:03 ` [PATCH 0/2] doc: log: fix --decorate " Junio C Hamano
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=source_block_description_list.627@msgid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.