[PATCH v2 2/2] t0450: add allowlist for builtins with missing .adoc
- From
Toon Claes <toon@iotcl.com>
- Date
- Aug 8, 2025, 09:59 UTC
- Message-ID
- <20250808095943.3312265-3-toon@iotcl.com>
- 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