From: Tuomas Ahola <taahol@utu.fi>
To: <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>, Julia Evans <julia@jvns.ca>,
Patrick Steinhardt <ps@pks.im>,
Kristoffer Haugsbakk <code@khaugsbakk.name>,
Jeff King <peff@peff.net>, Tuomas Ahola <taahol@utu.fi>
Subject: [PATCH v3 0/2] guides: keep Documentation/Makefile and command-list.txt in sync
Date: Thu, 29 Oct 2026 20:48:32 +0200 [thread overview]
Message-ID: <20261029184834.2273-1-taahol@utu.fi> (raw)
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
next prev parent reply other threads:[~2026-10-29 18:49 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-09 5:24 [PATCH 0/2] guides: keep Documentation/Makefile and command-list.txt in sync Tuomas Ahola
2026-09-09 5:25 ` [PATCH 1/2] command-list: add gitformat-loose(5) and gitpacking(7) Tuomas Ahola
2026-09-09 18:15 ` Junio C Hamano
2026-09-09 5:25 ` [PATCH 2/2] lint-docs: check the guide list in command-list.txt Tuomas Ahola
2026-09-09 18:15 ` Junio C Hamano
2026-09-10 19:43 ` [PATCH v2 0/2] guides: keep Documentation/Makefile and command-list.txt in sync Tuomas Ahola
2026-09-10 19:43 ` [PATCH v2 1/2] command-list.txt: add gitformat-loose(5) and gitpacking(7) Tuomas Ahola
2026-09-10 19:43 ` [PATCH v2 2/2] lint-docs: check the guide list in command-list.txt Tuomas Ahola
2026-10-29 18:48 ` Tuomas Ahola [this message]
2026-10-29 18:48 ` [PATCH v3 " Tuomas Ahola
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261029184834.2273-1-taahol@utu.fi \
--to=taahol@utu.fi \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=julia@jvns.ca \
--cc=peff@peff.net \
--cc=ps@pks.im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox