[PATCH v3 0/2] guides: keep Documentation/Makefile and command-list.txt in sync
- From
Tuomas Ahola <taahol@utu.fi>
- Date
- Oct 29, 2026, 18:48 UTC
- Message-ID
- <20261029184834.2273-1-taahol@utu.fi>
- In-Reply-To
- <20260909052501.8448-1-taahol@utu.fi>
A new linter test has been added to Documentation/lint-manpages.sh to ensure that all non-command manual pages (concept guides and interface manuals) listed in Documentation/Makefile are present in command-list.txt.
Changes in v3:
* [2/2]: - Exempt obsoleted gittutorial-2(7). - Even more defensive quotation.
Changes in v2:
* [1/2]: Use command-list.txt as the area identifier. * [2/2]: Protect variables againtst whitespace breakage per review comment.
synthetic-base: master + je/doc-remove-gittutorial-2
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 | 11 ++++++++--- command-list.txt | 2 ++ 3 files changed, 12 insertions(+), 3 deletions(-)
Intervall-diff mot v2:
1: cb6ce6cad1 = 1: 9a1ba61ac0 command-list.txt: add gitformat-loose(5) and gitpacking(7)
2: 2dc1ee4514 ! 2: 5d36d75859 lint-docs: check the guide list in command-list.txt
@@ Commit message
Adapt Documentation/lint-manpages.sh to fill that role. Extract
MAN5_TXT and MAN7_TXT from the Makefile and check command-list.txt
- against them. Exempt gitweb.conf(5) from the new linter routine.
+ against them. Exempt gitweb.conf(5) and gittutorial-2(7) from the
+ new linter routine.
Signed-off-by: Tuomas Ahola <taahol@utu.fi>
@@ Documentation/lint-manpages.sh
#!/bin/sh
extract_variable () {
-+ file=${2:-../Makefile}
-+ directory=$(dirname "$file")
++ file="${2:-../Makefile}"
++ directory="$(dirname "$file")"
(
- cat ../Makefile
+ cat "$file"
@@ Documentation/lint-manpages.sh: check_missing_docs () (
git-stage) continue;;
git-legacy-*) continue;;
git-?*--?* ) continue ;;
++ gittutorial-2) continue ;;
+ gitweb.conf) continue ;;
esac
base-commit: b9e5cff1803ab24582201ef059516eb16014b9d9 prerequisite-patch-id: 7f3cc00ab656bf1192d93c2e6a434c0d0fda2b6b prerequisite-patch-id: eb8fbd9fc3f96e3cbffddbeaf47b99f397e5330b
-- ta/command-list-guides-sync-lint