[PATCH v2 0/2] guides: keep Documentation/Makefile and command-list.txt in sync
- From
Tuomas Ahola <taahol@utu.fi>
- Date
- Sep 10, 2026, 19:43 UTC
- Message-ID
- <20260910194351.20809-1-taahol@utu.fi>
- In-Reply-To
- <20260909052501.8448-1-taahol@utu.fi>
Documentation/lint-manpages.sh was expanded with a new test ensuring that command-list.txt also includes all non-command manual pages (concept guides and interface manuals).
Based on kh/doc-datamodel.
Changes in v2:
* [1/2]: Use command-list.txt as the area identifier. * [2/2]: Protect variables againtst whitespace breakage per review comment.
Tuomas Ahola (2): command-list.txt: add gitformat-loose(5) and gitpacking(7) lint-docs: check the guide list in command-list.txt
Documentation/Makefile | 2 ++ Documentation/lint-manpages.sh | 10 +++++++--- command-list.txt | 2 ++ 3 files changed, 11 insertions(+), 3 deletions(-)
Intervall-diff mot v1:
1: 014da7fdff ! 1: cb6ce6cad1 command-list: add gitformat-loose(5) and gitpacking(7)
@@ Metadata
Author: Tuomas Ahola <taahol@utu.fi>
## Commit message ##
- command-list: add gitformat-loose(5) and gitpacking(7)
+ command-list.txt: add gitformat-loose(5) and gitpacking(7)
Three manpages from sections 5 and 7 are not featured in
command-list.txt as concept guides or interface manuals.
2: b24d96f732 ! 2: 2dc1ee4514 lint-docs: check the guide list in command-list.txt
@@ Documentation/lint-manpages.sh
extract_variable () {
+ file=${2:-../Makefile}
++ directory=$(dirname "$file")
(
- cat ../Makefile
-+ cat $file
++ 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 $(dirname $file) -f - print_variable 2>/dev/null |
++ make -C "$directory" -f - print_variable 2>/dev/null |
sed -n -e 's/.*XXX \(.*\) YYY.*/\1/p'
}
base-commit: b8242b093d9e941a34460d715e3ce616a34ac3fe
-- ta/command-list-guides-sync-lint