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

Re: Documentation options: Code or not?

From
Jean-Noël Avila <jn.avila@free.fr>
Date
Jan 5, 2026, 10:01 UTC
Message-ID
<eaf31f3d-83ab-4afc-8b78-0d017de6b580@free.fr>
In-Reply-To
<2076768.usQuhbGJ8B@debian-mbp>
Hi,
The process of converting all the manpages to the `synopsis` style
is ongoing.
The aim is to use the "smart" synopsis format (using backticks for
 inline code), for which a parser makes the special formatting for
 keywords, placeholders and grammatical marks.
I took the path of converting the pages in the order of appearance
on git-scm.com.
For a good idea of the final rendering, you can check git-commit or
git-add. I'm always open to a helping hand in this task, with enough
communication to not duplicate work. To be honest, the conversion process
is far from being completely formalized, so you may need a couple
iterations before the rules are completely clear.
Let me know if you are interested.
JN
Previous: Junio C Hamano
Message 3 of 3 in “Documentation options: Code or not?”
  1. Michael LyonsJan 4, 2026
  2. Junio C HamanoJan 5, 2026
  3. Jean-Noël AvilaJan 5, 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.