From: Todd Zullinger <tmz@pobox.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Jean-Noël Avila" <jn.avila@free.fr>, git@vger.kernel.org
Subject: [PATCH v2 0/2] doc lint fixes for pack-refs and refs
Date: Tue, 15 Sep 2026 09:10:30 -0400 [thread overview]
Message-ID: <20260915131036.393249-1-tmz@pobox.com> (raw)
In-Reply-To: <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.
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 <tmz@pobox.com>
3: 7af3718a71 = 2: 9475c1c1bc doc/refs: backtick-quote commands and options consistently
--
2.56.0.rc0
next prev parent reply other threads:[~2026-09-15 13:10 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-12 19:14 [PATCH 0/3] doc lint fixes for pack-refs and refs Todd Zullinger
2026-09-12 19:15 ` [PATCH 1/3] doc lint: match commands as well as options for synopsis style check Todd Zullinger
2026-09-12 19:15 ` [PATCH 2/3] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-12 19:15 ` [PATCH 3/3] doc/refs: backtick-quote commands and options consistently Todd Zullinger
2026-09-13 10:26 ` [PATCH 0/3] doc lint fixes for pack-refs and refs Jean-Noël AVILA
2026-09-13 14:14 ` Todd Zullinger
2026-09-14 12:46 ` [PATCH v2 0/2] " Todd Zullinger
2026-09-14 12:46 ` [PATCH v2 1/2] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-14 15:30 ` Junio C Hamano
2026-09-14 15:43 ` Todd Zullinger
2026-09-15 13:15 ` Todd Zullinger
2026-09-14 12:46 ` [PATCH v2 2/2] doc/refs: backtick-quote commands and options consistently Todd Zullinger
2026-09-15 13:10 ` Todd Zullinger [this message]
2026-09-15 16:25 ` [PATCH v2 0/2] doc lint fixes for pack-refs and refs Junio C Hamano
2026-09-15 13:10 ` [PATCH v3 1/2] doc/pack-refs: convert synopsis and options to new style Todd Zullinger
2026-09-15 13:10 ` [PATCH v3 2/2] doc/refs: backtick-quote commands and options consistently Todd Zullinger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260915131036.393249-1-tmz@pobox.com \
--to=tmz@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jn.avila@free.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox