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

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

From
Todd Zullinger <tmz@pobox.com>
Date
Sep 12, 2026, 19:14 UTC
Message-ID
<20260912191509.844954-1-tmz@pobox.com>

I was reading git-refs(1) after noticing it learned some new tricks in the 2.56.0 release notes. The formatting stood out because the first two commands, migrate and verify are bold (in the man pages) but subsequent commands are not. The HTML is similarly affected, with those commands colored differently than the rest in our online documentation:

    https://git-scm.com/docs/git-refs
This is due to inconsistent backtick-quotes.

This led me to the lint check, which I think might benefit from the small change here to match commands as well as options. Running something like this reports a number of files which could also use some tweaks:

    cd Documentation && for i in *.adoc; do
        output=$(perl lint-documentation-style.perl <$i 2>&1)
        [[ -n $output ]] && printf '\n%s:\n%s\n' $i "$output"
    done

I _think_ we want to backtick-quote those when using the synopsis style. (If not, then the change is wrong and we should remove the backticks from the two commands in git-refs.adoc and other places.)

As git-refs.adoc includes pack-refs-options.adoc, I updated it to consistently use backtick quoting and converted the only other file which includes it, git-pack-refs.adoc.

Todd Zullinger (3):
  doc lint: match commands as well as options for synopsis style check
  doc/pack-refs: convert synopsis and options to new style
  doc/refs: backtick-quote commands and options consistently
 Documentation/git-pack-refs.adoc            |  8 ++++----
 Documentation/git-refs.adoc                 | 14 +++++++-------
 Documentation/lint-documentation-style.perl |  4 ++--
 Documentation/pack-refs-options.adoc        | 10 +++++-----
 4 files changed, 18 insertions(+), 18 deletions(-)
-- 
2.56.0.rc0
Next: Todd Zullinger
Message 1 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.