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

Re: [PATCH 1/1] doc: git-bisect: convert to new doc format

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 12, 2026, 03:13 UTC
Message-ID
<xmqq1pjvplp8.fsf@gitster.g>
In-Reply-To
<20260111204316.836446-2-git@michael.lyo.nz>
Michael Lyons <git@michael.lyo.nz> writes:
> - Change placeholders to glossary terms

I see you changed <rev> to <commit> and I guess the point above is a reference to that change, but I cannot be sure if (1) there are things other than <rev> that you changed for the same reason, and (2) if "glossary has it" is the reason for the change (we have "revision" in there, and it is widely known that "rev" is an abbreviation for it in the context of these documentation pages).

You can rephrase the above, perhaps like
    Some parameters are described with placeholders with less common
    words, which is unnecessarily harder to understand by new
    readers.  Use <commit> instead of <rev>.

to avoid the problem, if <rev> -> <commit> is the only change for this reason. If there are more words you addressed, perhaps you can replace the last sentence.

> - Refer to placeholders in prose
> - Delimit runnable commands and CLI args with backticks
> - Link internal heading
The same comments may apply to these three.
Thanks.
Previous: Michael LyonsNext: Jean-Noël AVILA
Message 3 of 6 in “doc: git-bisect to synopsis”
  1. 0/1 doc: git-bisect to synopsisMichael Lyons, Jan 11, 2026
  2. 1/1 doc: git-bisect: convert to new doc formatMichael Lyons, Jan 11, 2026
  3. Junio C HamanoJan 12, 2026
  4. Jean-Noël AVILAJan 12, 2026
  5. Junio C HamanoJan 13, 2026
  6. Jean-Noël AvilaJan 13, 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.