Merge branch 'ta/command-list-guides-sync-lint' into seen

The manual page linter has been extended to ensure that concept
guides and interface manuals listed in the documentation makefile
are also properly featured in the command list.

* ta/command-list-guides-sync-lint:
  lint-docs: check the guide list in command-list.txt
  command-list.txt: add gitformat-loose(5) and gitpacking(7)
This commit is contained in:
Junio C Hamano committed 2026-11-05 20:45:55 -08:00
commit 3de8ebe6c8
3 files changed
+12 -3

No files matched your search

+2
View File
@@ -70,6 +70,8 @@ MAN7_TXT += gittutorial-2.adoc
MAN7_TXT += gittutorial.adoc
MAN7_TXT += gitworkflows.adoc
MAN_GUIDES = $(patsubst %.adoc,%,$(MAN5_TXT) $(MAN7_TXT))
HOWTO_TXT += $(wildcard howto/*.adoc)
DOC_DEP_TXT += $(wildcard *.adoc)
+8 -3
View File
@@ -1,21 +1,23 @@
#!/bin/sh
extract_variable () {
file="${2:-../Makefile}"
directory="$(dirname "$file")"
(
cat ../Makefile
cat "$file"
cat <<EOF
print_variable:
@\$(foreach b,\$($1),echo XXX \$(b:\$X=) YYY;)
EOF
) |
make -C .. -f - print_variable 2>/dev/null |
make -C "$directory" -f - print_variable 2>/dev/null |
sed -n -e 's/.*XXX \(.*\) YYY.*/\1/p'
}
check_missing_docs () (
ret=0
for v in $ALL_COMMANDS
for v in $ALL_COMMANDS $MAN_GUIDES
do
case "$v" in
git-merge-octopus) continue;;
@@ -29,6 +31,8 @@ check_missing_docs () (
git-stage) continue;;
git-legacy-*) continue;;
git-?*--?* ) continue ;;
gittutorial-2) continue ;;
gitweb.conf) continue ;;
esac
if ! test -f "$v.adoc"
@@ -87,6 +91,7 @@ check_extraneous_docs () {
BUILT_INS="$(extract_variable BUILT_INS)"
ALL_COMMANDS="$(extract_variable ALL_COMMANDS)"
EXCLUDED_PROGRAMS="$(extract_variable EXCLUDED_PROGRAMS)"
MAN_GUIDES="$(extract_variable MAN_GUIDES ./Makefile)"
findings=$(
if ! check_missing_docs
+2
View File
@@ -226,6 +226,7 @@ gitformat-bundle developerinterfaces
gitformat-chunk developerinterfaces
gitformat-commit-graph developerinterfaces
gitformat-index developerinterfaces
gitformat-loose developerinterfaces
gitformat-pack developerinterfaces
gitformat-signature developerinterfaces
gitglossary guide
@@ -236,6 +237,7 @@ gitmailmap userinterfaces
gitmergeconflicts guide
gitmodules userinterfaces
gitnamespaces guide
gitpacking guide
gitprotocol-capabilities developerinterfaces
gitprotocol-common developerinterfaces
gitprotocol-http developerinterfaces