From: "SZEDER Gábor" <szeder.dev@gmail•com>
To: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail•com>
Cc: git@vger•kernel.org,
"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>,
"Jean-Noël Avila" <jn.avila@free•fr>
Subject: Re: [PATCH v3 7/9] doc: git-log: convert pretty formats to new doc format
Date: Sun, 17 Aug 2025 23:29:23 +0200 [thread overview]
Message-ID: <aKJJs7OkBIg7Y9J0@szeder.dev> (raw)
In-Reply-To: <0d461544c9d720e379a867a9713998bf09136885.1751914412.git.gitgitgadget@gmail.com>
On Mon, Jul 07, 2025 at 06:53:30PM +0000, Jean-Noël Avila via GitGitGadget wrote:
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free•fr>
>
> - Use _<placeholder>_ instead of <placeholder> in the description
> - Use `backticks` for keywords and more complex option
> descriptions. The new rendering engine will apply synopsis rules to
> these spans.
>
> For all the formats in the form of %(foo), the formatting needs to be
> heavier because we not want the parentheses to be rendered as syntax
> elements,but as keywords, i.e. we need to circumvent the syntax highlighting
> of synopsis. In this particular case, this requires the heavy escaping of
> the parts that contain parentheses with ++.
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free•fr>
> ---
> Documentation/pretty-formats.adoc | 283 +++++++++++++++---------------
> 1 file changed, 143 insertions(+), 140 deletions(-)
>
> diff --git a/Documentation/pretty-formats.adoc b/Documentation/pretty-formats.adoc
> index 07475de8c337..9ed0417fc811 100644
> --- a/Documentation/pretty-formats.adoc
> +++ b/Documentation/pretty-formats.adoc
> +++%(decorate++`[:<option>,...]`++)++::
> ref names with custom decorations. The `decorate` string may be followed by a
> colon and zero or more comma-separated options. Option values may contain
> literal formatting codes. These must be used for commas (`%x2C`) and closing
> parentheses (`%x29`), due to their role in the option syntax.
> +
> -** 'prefix=<value>': Shown before the list of ref names. Defaults to "{nbsp}`(`".
> -** 'suffix=<value>': Shown after the list of ref names. Defaults to "`)`".
> -** 'separator=<value>': Shown between ref names. Defaults to "`,`{nbsp}".
> -** 'pointer=<value>': Shown between HEAD and the branch it points to, if any.
> - Defaults to "{nbsp}`->`{nbsp}".
> -** 'tag=<value>': Shown before tag names. Defaults to "`tag:`{nbsp}".
> +** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}+(+".
> +** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+".
> +** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}".
> +** `pointer=<value>`: Shown between HEAD and the branch it points to, if any.
> + Defaults to "{nbsp}+->+{nbsp}".
> +** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}".
>
> +
> For example, to produce decorations with no wrapping
> or tag annotations, and spaces as separators:
> +
> -`%(decorate:prefix=,suffix=,tag=,separator= )`
> +++%(decorate:prefix=,suffix=,tag=,separator= )++
This section now looks like this when the man page is built with
Asciidoctor:
%(decorate[:<option>,...])
ref names with custom decorations. The decorate string may
be followed by a colon and zero or more comma-separated
options. Option values may contain literal formatting
codes. These must be used for commas (%x2C) and closing
parentheses (%x29), due to their role in the option syntax.
parentheses (%x29), due to their role in the option syntax.
• prefix=<value>: Shown before the list of ref names.
Defaults to " +(+".
• suffix=<value>: Shown after the list of ref names.
Defaults to ")".
• separator=<value>: Shown between ref names. Defaults to
", ".
• pointer=<value>: Shown between HEAD and the branch it
points to, if any. Defaults to " +→+ ".
• tag=<value>: Shown before tag names. Defaults to
"tag: ".
For example, to produce decorations with no wrapping or tag
annotations, and spaces as separators:
+ %(decorate:prefix=,suffix=,tag=,separator= )
Note the unnecessary + characters in the default values for 'prefix'
and 'pointer', and in the latter the "ASCII art" arrow ("->") is now
replaced with a unicode arrow character.
Also note that the last three lines are not aligned properly and the
example format string starts with a + character as well, but this was
the case even before this patch.
I use the distro packaged version of Asciidoctor:
$ asciidoctor --version
Asciidoctor 2.0.16 [https://asciidoctor.org]
Runtime Environment (ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux-gnu]) (lc:UTF-8 fs:UTF-8 in:UTF-8 ex:UTF-8)
next prev parent reply other threads:[~2025-08-17 21:29 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 [this message]
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 ` [PATCH v3 9/9] doc: git-log: convert log config " 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=aKJJs7OkBIg7Y9J0@szeder.dev \
--to=szeder.dev@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitgitgadget@gmail$(echo .)com \
--cc=jn.avila@free$(echo .)fr \
--cc=kristofferhaugsbakk@fastmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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