Skip to content

Commit f9a6705

Browse files
To1negitster
authored andcommitted
t0450: add allowlist for builtins with missing .adoc
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 <[email protected]> [jc: squashed Patrick's "missing file fix" in] Signed-off-by: Junio C Hamano <[email protected]>
1 parent f175b34 commit f9a6705

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

t/t0450-txt-doc-vs-help.sh

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,19 @@ do
112112
adoc="$(builtin_to_adoc "$builtin")" &&
113113
preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
114114

115-
if test -f "$adoc"
115+
# If and only if *.adoc is missing, builtin shall be listed in t0450/adoc-missing.
116+
if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-missing
116117
then
118+
test_expect_success "$builtin appropriately marked as not having .adoc" '
119+
! test -f "$adoc"
120+
'
121+
else
117122
test_set_prereq "$preq"
118-
fi &&
123+
124+
test_expect_success "$builtin appropriately marked as having .adoc" '
125+
test -f "$adoc"
126+
'
127+
fi
119128

120129
# *.adoc output assertions
121130
test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" '

t/t0450/adoc-missing

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
checkout--worker
2+
merge-ours
3+
merge-recursive
4+
merge-recursive-ours
5+
merge-recursive-theirs
6+
merge-subtree
7+
pickaxe
8+
submodule--helper
9+
upload-archive--writer

0 commit comments

Comments
 (0)