* [PATCH 0/2] check-docs: fix 'diagnose' and 'version'
@ 2022-09-20 0:19 Victoria Dye via GitGitGadget
2022-09-20 0:19 ` [PATCH 1/2] diagnose: add to command-list.txt Victoria Dye via GitGitGadget
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Victoria Dye via GitGitGadget @ 2022-09-20 0:19 UTC (permalink / raw)
To: git; +Cc: gitster, avarab, Victoria Dye
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'
executable.
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.
Thanks!
* Victoria
[1]
https://lore.kernel.org/git/pull.1310.v4.git.1660335019.gitgitgadget@gmail.com/
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
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1360%2Fvdye%2Fbugfix%2Fcheck-docs-fixes-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1360/vdye/bugfix/check-docs-fixes-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1360
--
gitgitgadget
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 1/2] diagnose: add to command-list.txt
2022-09-20 0:19 [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Victoria Dye via GitGitGadget
@ 2022-09-20 0:19 ` 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
2 siblings, 0 replies; 4+ messages in thread
From: Victoria Dye via GitGitGadget @ 2022-09-20 0:19 UTC (permalink / raw)
To: git; +Cc: gitster, avarab, Victoria Dye, Victoria Dye
From: Victoria Dye <vdye@github.com>
Add 'git diagnose' as an "ancilliaryinterrogator" (like 'git bugreport') to
'command-list.txt' in order to have it show up in 'git help -a' and avoid
the "no link" warning message from the 'check-docs' Makefile target.
Signed-off-by: Victoria Dye <vdye@github.com>
---
command-list.txt | 1 +
1 file changed, 1 insertion(+)
diff --git a/command-list.txt b/command-list.txt
index 93f94e42ab7..bb2e0a9214b 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -91,6 +91,7 @@ git-cvsimport foreignscminterface
git-cvsserver foreignscminterface
git-daemon synchingrepositories
git-describe mainporcelain
+git-diagnose ancillaryinterrogators
git-diff mainporcelain info
git-diff-files plumbinginterrogators
git-diff-index plumbinginterrogators
--
gitgitgadget
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 2/2] version: fix builtin linking & documentation
2022-09-20 0:19 [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Victoria Dye via GitGitGadget
2022-09-20 0:19 ` [PATCH 1/2] diagnose: add to command-list.txt Victoria Dye via GitGitGadget
@ 2022-09-20 0:19 ` Victoria Dye via GitGitGadget
2022-09-20 0:27 ` [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Junio C Hamano
2 siblings, 0 replies; 4+ messages in thread
From: Victoria Dye via GitGitGadget @ 2022-09-20 0:19 UTC (permalink / raw)
To: git; +Cc: gitster, avarab, Victoria Dye, Victoria Dye
From: Victoria Dye <vdye@github.com>
Like most builtins, 'version' is documented in a corresponding
'Documentation/git-version.txt' and can be invoked with 'git version'.
However, the 'check-docs' Makefile target showed that it was "removed but
documented: git-version." This was cause by the fact that it is not built as
a standalone 'git-version' executable, therefore appearing "removed" to
'check-docs'.
Without a precedent for documented builtins that aren't built into an
executable *or* any clear reason why a standalone 'git-version' shouldn't
exist, the 'check-docs' error appears to correctly identify an issue. To
correct that mismatch, add 'git-version' to the 'BUILT_INS' list in the root
Makefile (indicating that the 'cmd_version()' function appears in a file
that is *not* 'builtin/version.c'). Additionally, to avoid the "no link"
message in 'check-docs', list 'git-version' as an "ancilliaryinterrogator"
(like 'git help') in 'command-list.txt'.
Signed-off-by: Victoria Dye <vdye@github.com>
---
.gitignore | 1 +
Makefile | 1 +
command-list.txt | 1 +
3 files changed, 3 insertions(+)
diff --git a/.gitignore b/.gitignore
index 3d1b880101e..b3dcafcb331 100644
--- a/.gitignore
+++ b/.gitignore
@@ -181,6 +181,7 @@
/git-verify-commit
/git-verify-pack
/git-verify-tag
+/git-version
/git-web--browse
/git-whatchanged
/git-worktree
diff --git a/Makefile b/Makefile
index 35a07f80c52..cac3452edb9 100644
--- a/Makefile
+++ b/Makefile
@@ -818,6 +818,7 @@ BUILT_INS += git-show$X
BUILT_INS += git-stage$X
BUILT_INS += git-status$X
BUILT_INS += git-switch$X
+BUILT_INS += git-version$X
BUILT_INS += git-whatchanged$X
# what 'all' will build but not install in gitexecdir
diff --git a/command-list.txt b/command-list.txt
index bb2e0a9214b..54b2a50f5f1 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -199,6 +199,7 @@ git-var plumbinginterrogators
git-verify-commit ancillaryinterrogators
git-verify-pack plumbinginterrogators
git-verify-tag ancillaryinterrogators
+git-version ancillaryinterrogators
git-whatchanged ancillaryinterrogators complete
git-worktree mainporcelain
git-write-tree plumbingmanipulators
--
gitgitgadget
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 0/2] check-docs: fix 'diagnose' and 'version'
2022-09-20 0:19 [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Victoria Dye via GitGitGadget
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 ` Junio C Hamano
2 siblings, 0 replies; 4+ messages in thread
From: Junio C Hamano @ 2022-09-20 0:27 UTC (permalink / raw)
To: Victoria Dye via GitGitGadget; +Cc: git, avarab, Victoria Dye
"Victoria Dye via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 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'
> executable.
Very much appreciated. I agree that making it an error would have
helped us a lot, and I also agree with you that it can be left for
the next cycle.
Will queue. Thanks.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-09-20 0:27 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-09-20 0:19 [PATCH 0/2] check-docs: fix 'diagnose' and 'version' Victoria Dye via GitGitGadget
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
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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).