git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 4/4] doc: convert git-show to synopsis style

From
Jean-Noël AVILA <jn.avila@free.fr>
Date
Feb 1, 2026, 16:39 UTC
Message-ID
<9570525.CDJkKcVGEf@piment-oiseau>
In-Reply-To
<14561b83-c976-46b2-a441-45fdeced1912@app.fastmail.com>
On Sunday, 1 February 2026 13:12:47 CET Kristoffer Haugsbakk wrote:
Show 7 quoted lines
> >  +
> >  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.
> 
Show 57 quoted lines
> > -** `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.

Previous: Kristoffer HaugsbakkNext: Jean-Noël Avila via GitGitGadget
Message 20 of 38 in “doc: some more synopsis conversions and fixes”
  1. 0/4 doc: some more synopsis conversions and fixesJean-Noël Avila via GitGitGadget, Jan 23, 2026
  2. 1/4 convert git-submodule doc to synopsis styleJean-Noël Avila via GitGitGadget, Jan 23, 2026
  3. Kristoffer HaugsbakkFeb 1, 2026
  4. 2/4 doc: finalize git-clone documentation conversion to synopsis styleJean-Noël Avila via GitGitGadget, Jan 23, 2026
  5. Kristoffer HaugsbakkFeb 1, 2026
  6. Jean-Noël AVILAFeb 1, 2026
  7. Kristoffer HaugsbakkFeb 2, 2026
  8. 3/4 doc: fix some style issues in git-clone and for-each-ref-optionsJean-Noël Avila via GitGitGadget, Jan 23, 2026
  9. Kristoffer HaugsbakkFeb 1, 2026
  10. 4/4 doc: convert git-show to synopsis styleJean-Noël Avila via GitGitGadget, Jan 23, 2026
  11. Kristoffer HaugsbakkJan 25, 2026
  12. Jean-Noël AVILAJan 25, 2026
  13. Kristoffer HaugsbakkJan 26, 2026
  14. 0/4 doc: some more synopsis conversions and fixesJean-Noël Avila via GitGitGadget, Jan 26, 2026
  15. 1/4 convert git-submodule doc to synopsis styleJean-Noël Avila via GitGitGadget, Jan 26, 2026
  16. 2/4 doc: finalize git-clone documentation conversion to synopsis styleJean-Noël Avila via GitGitGadget, Jan 26, 2026
  17. 3/4 doc: fix some style issues in git-clone and for-each-ref-optionsJean-Noël Avila via GitGitGadget, Jan 26, 2026
  18. 4/4 doc: convert git-show to synopsis styleJean-Noël Avila via GitGitGadget, Jan 26, 2026
  19. Kristoffer HaugsbakkFeb 1, 2026
  20. Jean-Noël AVILAFeb 1, 2026
  21. 0/4 doc: some more synopsis conversions and fixesJean-Noël Avila via GitGitGadget, Feb 3, 2026
  22. 1/4 doc: convert git-submodule to synopsis styleJean-Noël Avila via GitGitGadget, Feb 3, 2026
  23. Kristoffer HaugsbakkFeb 3, 2026
  24. Jean-Noël AvilaFeb 6, 2026
  25. 2/4 doc: finalize git-clone documentation conversion to synopsis styleJean-Noël Avila via GitGitGadget, Feb 3, 2026
  26. Kristoffer HaugsbakkFeb 3, 2026
  27. 4/4 doc: convert git-show to synopsis styleJean-Noël Avila via GitGitGadget, Feb 3, 2026
  28. Kristoffer HaugsbakkFeb 3, 2026
  29. 3/4 doc: fix some style issues in git-clone and for-each-ref-optionsJean-Noël Avila via GitGitGadget, Feb 3, 2026
  30. Kristoffer HaugsbakkFeb 3, 2026
  31. Kristoffer HaugsbakkFeb 3, 2026
  32. Kristoffer HaugsbakkFeb 4, 2026
  33. 0/4 doc: some more synopsis conversions and fixesJean-Noël Avila via GitGitGadget, Feb 6, 2026
  34. 1/4 doc: convert git-submodule to synopsis styleJean-Noël Avila via GitGitGadget, Feb 6, 2026
  35. 2/4 doc: finalize git-clone documentation conversion to synopsis styleJean-Noël Avila via GitGitGadget, Feb 6, 2026
  36. 3/4 doc: fix some style issues in git-clone and for-each-ref-optionsJean-Noël Avila via GitGitGadget, Feb 6, 2026
  37. 4/4 doc: convert git-show to synopsis styleJean-Noël Avila via GitGitGadget, Feb 6, 2026
  38. Kristoffer HaugsbakkFeb 7, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.