t/README: reword the "GIT_TEST_PASSING_SANITIZE_LEAK" description
Reword the documentation added in 956d2e4639b (tests: add a test mode for SANITIZE=leak, run it in CI, 2021-09-23) for brevity. The comment added in the same commit was also misleading: We skip certain tests if SANITIZE=leak and GIT_TEST_PASSING_SANITIZE_LEAK=true, not if we're compiled with SANITIZE=leak. Let's just remove the comment, the control flow here is obvious enough that the code can speak for itself. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Jul 28, 2022 at 01:13 UTC
ac8e3e94e56eb13ca4bd023973501c6a3ad8fd98
2 files changed
+4
-7
t/README
+4
-6
@@ -366,12 +366,10 @@ excluded as so much relies on it, but this might change in the future.
366
GIT_TEST_SPLIT_INDEX=<boolean> forces split-index mode on the whole
367
test suite. Accept any boolean values that are accepted by git-config.
368
369
-GIT_TEST_PASSING_SANITIZE_LEAK=<boolean> when compiled with
370
-SANITIZE=leak will run only those tests that have whitelisted
371
-themselves as passing with no memory leaks. Tests can be whitelisted
372
-by setting "TEST_PASSES_SANITIZE_LEAK=true" before sourcing
373
-"test-lib.sh" itself at the top of the test script. This test mode is
374
-used by the "linux-leaks" CI target.
369
+GIT_TEST_PASSING_SANITIZE_LEAK=true skips those tests that haven't
370
+declared themselves as leak-free by setting
371
+"TEST_PASSES_SANITIZE_LEAK=true" before sourcing "test-lib.sh". This
372
+test mode is used by the "linux-leaks" CI target.
373
374
GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'
375
default to n.
t/test-lib.sh
-1
@@ -1447,7 +1447,6 @@ then
1447
test_done
1448
fi
1449
1450
-# skip non-whitelisted tests when compiled with SANITIZE=leak
1450
if test -n "$SANITIZE_LEAK"
1451
then
1452
if test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false