mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Victoria Dye via GitGitGadget" <>
Cc:,, Victoria Dye <>
Subject: [PATCH 0/2] check-docs: fix 'diagnose' and 'version'
Date: Tue, 20 Sep 2022 00:19:53 +0000	[thread overview]
Message-ID: <> (raw)

While locally verifying an unrelated documentation change, I noticed that
the 'check-docs' target displayed two warnings on the 'master' branch:

no link: git-diagnose
removed but documented: git-version

The first message was due to the introduction of 'git diagnose' [1] not
including a corresponding update to 'command-list.txt'; the latter was due
to 'git-version' not being built as a standalone builtin executable. This
series corrects both, adding 'git-diagnose' and 'git-version' as
"ancilliaryinterrogators" to 'command-list.txt' and building a 'git-version'

A possible future improvement to avoid this sort of thing could be to have
'check-docs' exit with an error if it encounters any issues (rather than
printing a warning that's easily lost in build logs). For now, though, this
series is restricted to fixing what's currently broken for ease of review
and minimal risk.

Maintainer's note: if this would be too much of a disruption to include in
v2.38 last-minute, I'm happy deferring it to the next release cycle.
Alternatively, the series could be split, aiming to review & merge the first
patch in this release cycle (since the 'git diagnose' error was introduced
in this version) and leave the second the next cycle.


 * Victoria


Victoria Dye (2):
  diagnose: add to command-list.txt
  version: fix builtin linking & documentation

 .gitignore       | 1 +
 Makefile         | 1 +
 command-list.txt | 2 ++
 3 files changed, 4 insertions(+)

base-commit: dda7228a83e2e9ff584bf6adbf55910565b41e14
Fetch-It-Via: git fetch pr-1360/vdye/bugfix/check-docs-fixes-v1

             reply	other threads:[~2022-09-20  0:20 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-20  0:19 Victoria Dye via GitGitGadget [this message]
2022-09-20  0:19 ` [PATCH 1/2] diagnose: add to command-list.txt Victoria Dye via GitGitGadget
2022-09-20  0:19 ` [PATCH 2/2] version: fix builtin linking & documentation Victoria Dye via GitGitGadget
2022-09-20  0:27 ` [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Junio C Hamano

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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \

* 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.
Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).