Describe every check in the docs test header

1 file changed, 5 insertions, 5 deletions

diff --git a/tests/t0004-docs.sh b/tests/t0004-docs.shindex 339f50c..9fe4f87 100755--- a/tests/t0004-docs.sh+++ b/tests/t0004-docs.sh@@ -1,10 +1,10 @@ #!/bin/sh -# Checks that the configuration documents stay consistent with each other.-# The manual documents every key the reference config sets, the reference-# config sets every key the manual documents and puts scan-path after every-# global setting, and both settings sections of the manual keep their entries-# sorted.+# Checks that the configuration documents stay consistent with each other and+# with cgit. The manual and the reference config name the same keys, and cgit+# accepts every key the manual documents and no other. The reference config+# changes nothing as it ships and puts scan-path after every global setting.+# Both settings sections of the manual keep their entries sorted.  test_description='Check the configuration documents' CGIT_TEST_NO_CREATE_REPOS=YesPlease
diff --git a/tests/t0004-docs.sh b/tests/t0004-docs.sh
index 339f50c..9fe4f87 100755
--- a/tests/t0004-docs.sh
+++ b/tests/t0004-docs.sh
@@ -1,10 +1,10 @@
 #!/bin/sh
 
-# Checks that the configuration documents stay consistent with each other.
-# The manual documents every key the reference config sets, the reference
-# config sets every key the manual documents and puts scan-path after every
-# global setting, and both settings sections of the manual keep their entries
-# sorted.
+# Checks that the configuration documents stay consistent with each other and
+# with cgit. The manual and the reference config name the same keys, and cgit
+# accepts every key the manual documents and no other. The reference config
+# changes nothing as it ships and puts scan-path after every global setting.
+# Both settings sections of the manual keep their entries sorted.
 
 test_description='Check the configuration documents'
 CGIT_TEST_NO_CREATE_REPOS=YesPlease