All of lore.kernel.org
 help / color / mirror / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: "Jean-Noël AVILA" <jn.avila@free.fr>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 0/3] doc lint fixes for pack-refs and refs
Date: Sun, 13 Sep 2026 10:14:05 -0400	[thread overview]
Message-ID: <20260913141405.Dcx5xbe-@teonanacatl.net> (raw)
In-Reply-To: <Uds1uZlUTZi1p6vFK4zhWg@free.fr>

Hi,

Jean-Noël AVILA wrote:
> 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

  reply	other threads:[~2026-09-13 14:14 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 [this message]
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 ` [PATCH v2 0/2] doc lint fixes for pack-refs and refs Todd Zullinger
2026-09-15 16:25   ` 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=20260913141405.Dcx5xbe-@teonanacatl.net \
    --to=tmz@pobox.com \
    --cc=git@vger.kernel.org \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.