test: demonstrate insufficiently commented tests (#13221)

Ideally, all tests should have comments describing what they're testing.
Some old tests do not fulfill this criteria, this rule makes note of
them by writing them all in a file. We should not grow this file, but
shrink it over time by filling in the missing descriptions.

---------

Signed-off-by: Rudi Grinberg <me@rgrinberg.com>

Author: rgrinberg

flake.nix

@@ -167,6 +167,7 @@
               bc
               file
               jq
+              ripgrep
               mercurial
               unzip
               coreutils

test/blackbox-tests/dune

@@ -9,3 +9,19 @@
  (deps setup-script.sh)
  (action
   (run %{bin:bash} -n %{deps})))
+
+;; A list of tests that do not contain descriptions. This file should not not
+;; grow, only shrink. Once it is empty, it will become an error to introduce
+;; tests that do not have a description
+
+(rule
+ (target lacking-description)
+ (deps
+  %{bin:sort}
+  %{bin:rg}
+  ;; CR-someday rgrinberg: we need a recursive glob for source_tree
+  (source_tree test-cases))
+ (mode promote)
+ (action
+  (system
+   "rg --files-without-match '^\\S' --glob \"*.t\" --glob \"!*coq*\" --glob \"!*rocq*\" . | sort > %{target}")))

test/blackbox-tests/lacking-description

@@ -0,0 +1,144 @@
+./test-cases/actions/with-exit-codes.t
+./test-cases/actions/with-nested-exit-codes.t
+./test-cases/actions/with-stdin-from.t
+./test-cases/actions/with-unsupported-nested-exit-codes.t
+./test-cases/bad-alias-error/absolute-path.t/run.t
+./test-cases/bad-alias-error/outside-workspace.t/run.t
+./test-cases/block-strings.t/run.t
+./test-cases/cmdliner-dep-conf.t/run.t
+./test-cases/ctypes/github-5561-name-mangle.t
+./test-cases/custom-cross-compilation/bad-configuration.t/run.t
+./test-cases/custom-cross-compilation/context-not-found.t/run.t
+./test-cases/custom-cross-compilation/cross-compilation.t/run.t
+./test-cases/custom-cross-compilation/normal.t/run.t
+./test-cases/custom-cross-compilation/target-and-host.t/run.t
+./test-cases/custom-cross-compilation/topological-loop.t/run.t
+./test-cases/cycle-detection-symlinks-2863.t
+./test-cases/cyclic-dep-executable.t
+./test-cases/default-ocaml-flags-3-13.t
+./test-cases/depend-on/the-universe.t/run.t
+./test-cases/deprecated-fields/d-allow-approx-merlin.t
+./test-cases/deps-conf-vars/alias-lib-file.t
+./test-cases/deps-conf-vars/static.t
+./test-cases/dialects/bad3.t/run.t
+./test-cases/directory-targets/old-style/dep.t/run.t
+./test-cases/directory-targets/old-style/target.t/run.t
+./test-cases/double-echo.t/run.t
+./test-cases/dune-binaries.t
+./test-cases/dune-init/github7806.t
+./test-cases/dune_memory-and-the-universe.t/run.t
+./test-cases/enabled_if/eif-dune-describe.t
+./test-cases/enabled_if/eif-ocaml_version_lte.t/run.t
+./test-cases/env/env-cflags.t/run.t
+./test-cases/env/env-link_flags.t/run.t
+./test-cases/env/env-var-expansion/missing-default-in-blang.t/run.t
+./test-cases/env/env-var-expansion/nesting.t/run.t
+./test-cases/exclude-missing-module.t/run.t
+./test-cases/exec/dune-build-dir-exec-1101.t/run.t
+./test-cases/extensions-versioning/version-unknown.t/run.t
+./test-cases/extra-lang-line.t/run.t
+./test-cases/findlib-dynload.t/run.t
+./test-cases/foreign-stubs/exes-with-c.t/run.t
+./test-cases/foreign-stubs/fs-mode-dependent/fsmd-simple.t/run.t
+./test-cases/foreign-stubs/github1395.t/run.t
+./test-cases/foreign-stubs/github734.t/run.t
+./test-cases/formatting/empty-field.t
+./test-cases/formatting/error-field.t
+./test-cases/github10685.t
+./test-cases/github10721.t
+./test-cases/github20.t/run.t
+./test-cases/github2123.t/run.t
+./test-cases/github2584.t
+./test-cases/github2629.t
+./test-cases/github3180.t
+./test-cases/github3672.t
+./test-cases/github4194.t
+./test-cases/github5273.t
+./test-cases/github534.t/run.t
+./test-cases/github5528.t
+./test-cases/github568.t/run.t
+./test-cases/github597.t/run.t
+./test-cases/github761.t/run.t
+./test-cases/github764.t/run.t
+./test-cases/github784.t/run.t
+./test-cases/glob-deps-change.t/run.t
+./test-cases/ignored_subdirs/1.6.t/run.t
+./test-cases/ignored_subdirs/glob.t/run.t
+./test-cases/ignored_subdirs/logical.t/run.t
+./test-cases/ignored_subdirs/pre-1.6.t/run.t
+./test-cases/include-qualified/exe.t
+./test-cases/include-subdirs/error1.t/run.t
+./test-cases/include-subdirs/error2.t/run.t
+./test-cases/include-subdirs/error3.t/run.t
+./test-cases/inline-tests/many-backends-choose.t
+./test-cases/inline-tests/missing-backend.t
+./test-cases/inline-tests/too-many-backends.t
+./test-cases/installable-dup-private-libs.t/run.t
+./test-cases/install-dir/install-bindir.t
+./test-cases/install-dir/install-datadir.t
+./test-cases/install-dir/install-docdir.t
+./test-cases/install-dir/install-etcdir.t
+./test-cases/install-dir/install-mandir.t
+./test-cases/install-dry-run.t/run.t
+./test-cases/jsoo/env.t
+./test-cases/jsoo/sourcemap.t/run.t
+./test-cases/jsoo/without_implem.t/run.t
+./test-cases/lib-available.t/run.t
+./test-cases/melange/runtime-deps-in-target-dir.t
+./test-cases/menhir/cmly.t/run.t
+./test-cases/menhir/env.t/run.t
+./test-cases/merlin/dump-dot-merlin.t/run.t
+./test-cases/merlin/future-syntax.t
+./test-cases/merlin/github759.t/run.t
+./test-cases/merlin/include-subdirs-qualified.t
+./test-cases/merlin/suffix.t/run.t
+./test-cases/meta-gen.t/run.t
+./test-cases/mwe-dune-duplicate-dialect.t/duniverse/dune-configurator.2.7.1/test/dialects.t/run.t
+./test-cases/name-field-validation/no-name-exes-syntax-1-0.t/run.t
+./test-cases/null-dep.t/run.t
+./test-cases/ocamldep/ocamldep-multi-stanzas.t/run.t
+./test-cases/ocamllex/ocamllex-include-qualified.t
+./test-cases/ocamllex/ocamllex-include-unqualified.t
+./test-cases/odoc/github717-odoc-index.t/run.t
+./test-cases/odoc/new/github717-odoc-index.t/run.t
+./test-cases/package-dep.t/run.t
+./test-cases/pform-space-error-message.t
+./test-cases/ppx/9650-bytecode-rewriter.t/run.t
+./test-cases/private-modules/accessible-via-public.t/run.t
+./test-cases/private-modules/inaccessible-in-deps.t/run.t
+./test-cases/project-root.t/run.t
+./test-cases/promote/promotion-diff.t
+./test-cases/promote/promotion-list.t
+./test-cases/quoting/filename-space.t/run.t
+./test-cases/quoting/quote-from-context.t/run.t
+./test-cases/quoting/quotes-multi.t/run.t
+./test-cases/redirections.t/run.t
+./test-cases/select-field/select-2-0-rules.t
+./test-cases/select-field/select.t/run.t
+./test-cases/stanzas/dynamic-include-stanza/cycle.t
+./test-cases/stanzas/include-stanza/github2711.t
+./test-cases/stanzas/include-stanza/include-loop.t/run.t
+./test-cases/stanzas/tests/generated.t/run.t
+./test-cases/stanzas/tests/modes.t/run.t
+./test-cases/stanzas/tests/plural.t/run.t
+./test-cases/stanzas/tests/singular.t/run.t
+./test-cases/stdlib/stdlib-flags.t
+./test-cases/targets-with-vars.t/run.t
+./test-cases/test-build-if/version.t
+./test-cases/tests-locks.t/tests/a.t
+./test-cases/tests-locks.t/tests-no-locks/b.t
+./test-cases/tests-locks.t/tests-no-locks/sub/d.t
+./test-cases/tests-locks.t/tests/sub/b.t
+./test-cases/top-module/load-with-pp.t
+./test-cases/unreadable-src.t
+./test-cases/unreadable-target.t
+./test-cases/use-meta.t/run.t
+./test-cases/utop/utop-default-implementation.t/run.t
+./test-cases/utop/utop-simple.t/run.t
+./test-cases/utop/utop-stubs.t/run.t
+./test-cases/virtual-libraries/impl-public-modules/unwrapped.t
+./test-cases/virtual-libraries/module-fields.t/run.t
+./test-cases/windows-diff.t/run.t
+./test-cases/workspaces/custom-context-names.t
+./test-cases/wrapped-false-main-module-name.t/run.t
+./test-cases/wrapped-transition.t/run.t