From: Toon Claes <toon@iotcl•com>
To: git@vger•kernel.org
Cc: Patrick Steinhardt <ps@pks•im>, Toon Claes <toon@iotcl•com>
Subject: [PATCH v2 2/2] t0450: add allowlist for builtins with missing .adoc
Date: Fri, 8 Aug 2025 11:59:43 +0200 [thread overview]
Message-ID: <20250808095943.3312265-3-toon@iotcl.com> (raw)
In-Reply-To: <20250804073002.1586332-1-toon@iotcl.com>
Before we were silently skipping all builtins that don't have a matching
.adoc file. This is overly loose and might skip documentation files
when it shouldn't, for example when there was a typo in the filename.
To ensure no new builtins are added without documentation, add an
allowlist: t0450/adoc-missing. In this file only builtin commands that
do *not* have a corresponding .adoc file shall be listed. If there is a
mismatch, fail the test. This should force future contributions to
either add an .adoc, or add the builtin name to the allowlist file.
Signed-off-by: Toon Claes <toon@iotcl•com>
---
t/t0450-txt-doc-vs-help.sh | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh
index da2d0af5b0..980130be78 100755
--- a/t/t0450-txt-doc-vs-help.sh
+++ b/t/t0450-txt-doc-vs-help.sh
@@ -112,10 +112,16 @@ do
adoc="$(builtin_to_adoc "$builtin")" &&
preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
- if test -f "$adoc"
+ # if and only if *.adoc is missing, builtin shall be listed in t0450/adoc-missing
+ result=success
+ if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-missing
then
test_set_prereq "$preq"
+ result=failure
fi &&
+ test_expect_$result "$builtin appropriately marked as having missing .adoc" '
+ test -f "$adoc"
+ '
# *.adoc output assertions
test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" '
--
2.50.1.327.g047016eb4a
next prev parent reply other threads:[~2025-08-08 10:00 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-04 7:30 [PATCH] t0450: fix test for out-of-tree builds Toon Claes
2025-08-04 7:56 ` Patrick Steinhardt
2025-08-05 12:11 ` Toon Claes
2025-08-08 9:59 ` [PATCH v2 0/2] Harden test t0450-txt-doc-vs-help Toon Claes
2025-08-08 9:59 ` [PATCH v2 1/2] t0450: fix test for out-of-tree builds Toon Claes
2025-08-08 9:59 ` Toon Claes [this message]
2025-08-08 22:07 ` [PATCH v2 2/2] t0450: add allowlist for builtins with missing .adoc Junio C Hamano
2025-08-12 12:52 ` Patrick Steinhardt
2025-08-28 23:12 ` Junio C Hamano
2025-09-02 20:57 ` Junio C Hamano
2025-09-03 11:26 ` Toon Claes
2025-09-03 18:46 ` Junio C Hamano
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=20250808095943.3312265-3-toon@iotcl.com \
--to=toon@iotcl$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=ps@pks$(echo .)im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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