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

Documentation options: Code or not?

From
MLMichael Lyons <git@michael.lyo.nz>
Date
Jan 4, 2026, 18:04 UTC
Message-ID
<2076768.usQuhbGJ8B@debian-mbp>

I noticed that git-scm.com's documentation for `git-am` has a different color for the rerere options than it does for the other ones. Those options are imported from rerere-options.adoc, which adds code backticks to the keys:

`--rerere-autoupdate`::
`--no-rerere-autoupdate`::
	After the rerere mechanism reuses a recorded resolution...

I started a quick commit to drop the backticks from rerere-options, but then sampled a few other doc pages. Some use backticks (git-merge, git-repo), and some don't (git-prune, git-name-rev). Is there a preferred style? Would an update to make them consistent be useful or just annoying?

Thank you, Michael

Next: Junio C Hamano
Message 1 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.