From: "Jean-Noël AVILA" <jn.avila@free.fr>
To: "Jean-Noël Avila" <gitgitgadget@gmail.com>,
git@vger.kernel.org,
"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
Subject: Re: [PATCH v2 4/4] doc: convert git-show to synopsis style
Date: Sun, 01 Feb 2026 17:39:48 +0100 [thread overview]
Message-ID: <9570525.CDJkKcVGEf@piment-oiseau> (raw)
In-Reply-To: <14561b83-c976-46b2-a441-45fdeced1912@app.fastmail.com>
On Sunday, 1 February 2026 13:12:47 CET Kristoffer Haugsbakk wrote:
> > +
> > This format is used to refer to another commit in a commit message and
> > is the same as ++--pretty=\'format:%C(auto)%h (%s, %ad)'++. By default,
>
> Not a change here but while `--pretty...` has all the symbols it is
> partly rendered, partly not.
>
> > -** `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}".
>
> These are rendered serviceably.
>
> > -** `pointer=<value>`: Shown between HEAD and the branch it points to,
> > if any.
> > - Defaults to "{nbsp}++->++{nbsp}".
>
> This one is just `->` but it’s a bit confusing:
>
> " -> ".
>
> (the spaces may be more narrow in the HTML?)
>
> And the `-` has verbatim typeface while `>` does not.
>
> I said the preceding ones were serviceable in the sense that they don’t
> look great but you see what they are. This one is questionable.
>
> > -** `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}".
>
> Here I feel some deja vu.
>
> > +
> >
> > ---
> >
> > For example, to produce decorations with no wrapping
> >
> > or tag annotations, and spaces as separators:
> > -
> > ++
> >
> > ++%(decorate:prefix=,suffix=,tag=,separator= )++
> >
> > ---
>
> Here is a a problem. The pluses in `++...++` are apparently markup. But
> the line starts with `+%` here:
>
> + %(decorate:prefix=,suffix=,tag=,separator= )
>
OK, I understand that you are using asciidoctor for compilation. This is a
difficult problem to sort out. For the translations, I'm working on an actual
parser:
https://github.com/jnavila/git-manpages-l10n/blob/master/asciidoctor-extensions.rb
When the parsing fails, the formatting rolls back to simple verbatim
formatting.
After polishing it a bit, this could make it into the git source, if the new
dependency is accepted.
In the mean time, all I can propose is to remove all formatting when
asciidoctor will not process it correctly and the output will be confusing.
next prev parent reply other threads:[~2026-02-01 16:39 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-23 21:14 [PATCH 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-01-23 21:15 ` [PATCH 1/4] convert git-submodule doc to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-01 12:04 ` Kristoffer Haugsbakk
2026-02-01 13:14 ` Jean-Noël AVILA
2026-02-02 8:36 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-01 12:11 ` Kristoffer Haugsbakk
2026-01-23 21:15 ` [PATCH 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-01-25 19:27 ` Kristoffer Haugsbakk
2026-01-25 21:11 ` Jean-Noël AVILA
2026-01-26 5:58 ` Kristoffer Haugsbakk
2026-01-26 21:25 ` [PATCH v2 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 1/4] convert git-submodule doc to synopsis style Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-01-26 21:25 ` [PATCH v2 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-01 12:12 ` Kristoffer Haugsbakk
2026-02-01 16:39 ` Jean-Noël AVILA [this message]
2026-02-03 17:03 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Jean-Noël Avila via GitGitGadget
2026-02-03 17:03 ` [PATCH v3 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-06 3:55 ` Jean-Noël Avila
2026-02-03 17:03 ` [PATCH v3 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-03 21:45 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-03 21:46 ` Kristoffer Haugsbakk
2026-02-03 17:03 ` [PATCH v3 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-03 21:44 ` Kristoffer Haugsbakk
2026-02-03 21:44 ` [PATCH v3 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
2026-02-04 16:24 ` Kristoffer Haugsbakk
2026-02-06 4:12 ` [PATCH v4 " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 1/4] doc: convert git-submodule to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 2/4] doc: finalize git-clone documentation conversion " Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 3/4] doc: fix some style issues in git-clone and for-each-ref-options Jean-Noël Avila via GitGitGadget
2026-02-06 4:12 ` [PATCH v4 4/4] doc: convert git-show to synopsis style Jean-Noël Avila via GitGitGadget
2026-02-07 14:24 ` [PATCH v4 0/4] doc: some more synopsis conversions and fixes Kristoffer Haugsbakk
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=9570525.CDJkKcVGEf@piment-oiseau \
--to=jn.avila@free.fr \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--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 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.