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

Re: [PATCH 0/3] doc lint fixes for pack-refs and refs

From
Todd Zullinger <tmz@pobox.com>
Date
Sep 13, 2026, 14:14 UTC
Message-ID
<20260913141405.Dcx5xbe-@teonanacatl.net>
In-Reply-To
<Uds1uZlUTZi1p6vFK4zhWg@free.fr>
Hi,
Jean-Noël AVILA wrote:
Show 11 quoted lines
> When I put this linting in place, I was specifically targeting the options. 
> The other cases of use of definition list could range from commands to real 
> definitions of words (see gitglossary.adoc and git-add.adoc), and extending 
> the match can trigger false positives. Backticked terms are supposed to be 
> immutable for translators, so this formatting should not be used for real 
> definitions. 
> For this reason, the regex is restricted on purpose, but selecting the files 
> to check to allow to extend the range of checks.
> , 
> FWIW, the proposed change triggers false positives for git-add.adoc, git-
> push.adoc, git-difftool.adoc, git-daemon.adoc and git-fetch.adoc.

That's fine, I don't mind dropping that patch if the false positives will be more annoying than skipping the checks for commands and missing some of them.

I'll wait a little before sending a re-roll with that dropped, in case anyone spots issues in the main patches to the pack-refs and refs docs.

Thanks,
-- 
Todd
Previous: Jean-Noël AVILANext: Todd Zullinger
Message 6 of 16 in “doc lint fixes for pack-refs and refs”
  1. 0/3 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 12, 2026
  2. 1/3 doc lint: match commands as well as options for synopsis style checkTodd Zullinger, Sep 12, 2026
  3. 2/3 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 12, 2026
  4. 3/3 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 12, 2026
  5. Jean-Noël AVILASep 13, 2026
  6. Todd ZullingerSep 13, 2026
  7. 0/2 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 14, 2026
  8. 1/2 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 14, 2026
  9. Junio C HamanoSep 14, 2026
  10. Todd ZullingerSep 14, 2026
  11. Todd ZullingerSep 15, 2026
  12. 2/2 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 14, 2026
  13. 1/2 doc/pack-refs: convert synopsis and options to new styleTodd Zullinger, Sep 15, 2026
  14. 0/2 doc lint fixes for pack-refs and refsTodd Zullinger, Sep 15, 2026
  15. Junio C HamanoSep 15, 2026
  16. 2/2 doc/refs: backtick-quote commands and options consistentlyTodd Zullinger, Sep 15, 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.