diff options
| author | Victoria Dye <vdye@github.com> | 2022-09-20 00:19:55 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-09-19 17:28:25 -0700 |
| commit | 9b1dc1c9d879368b6cfccb183f5fc19facb1d9df (patch) | |
| tree | d5530d45416c376d3aa372ef149aec09bc5616a0 /Makefile | |
| parent | 89c8048855e7193988a7991ad01af0c6d8cf9226 (diff) | |
| download | git-9b1dc1c9d879368b6cfccb183f5fc19facb1d9df.tar.gz | |
version: fix builtin linking & documentation
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 1 |
1 files changed, 1 insertions, 0 deletions
@@ -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 |