[PATCH v2 0/2] doc lint fixes for pack-refs and refs
From: Todd Zullinger <hidden>
Date: 2026-09-15 13:10:40
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.
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.
Changes since v2:
* improve wording of pack-refs commit message and change
"configuration key" to "options".
Changes since v1:
* Drop Documentation/lint-documentation-style.perl change. It
is likely to cause more false positives than we want.
Todd Zullinger (2):
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/pack-refs-options.adoc | 10 +++++-----
3 files changed, 16 insertions(+), 16 deletions(-)
Range-diff against v2:
1: 03c1e8c073 < -: ---------- doc lint: match commands as well as options for synopsis style check
2: eb3b95c7a7 ! 1: 280a322df0 doc/pack-refs: convert synopsis and options to new style
@@ Commit message
Replace [verse] with [synopsis] in the SYNOPSIS block and remove
single-quote formatting from the command name.
- Backtick-quote all option terms in the OPTIONS section and convert
- the standalone placeholder _<branch>_ in prose.
-
- Update the included pack-refs-options.adoc to backtick-quote all
- configuration key terms.
+ Backtick-quote all option terms in the OPTIONS section via the included
+ pack-refs-options.adoc and convert the standalone placeholder _<branch>_
+ in prose.
Signed-off-by: Todd Zullinger [off-list ref]
3: 7af3718a71 = 2: 9475c1c1bc doc/refs: backtick-quote commands and options consistently
--
2.56.0.rc0