t/README: reword the "GIT_TEST_PASSING_SANITIZE_LEAK" description

Reword the documentation added in 956d2e4639 (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>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-07-28 01:13:33 +02:00 committed by Junio C Hamano
parent 46fb057aaa
commit ac8e3e94e5
2 changed files with 4 additions and 7 deletions

View File

@ -366,12 +366,10 @@ excluded as so much relies on it, but this might change in the future.
GIT_TEST_SPLIT_INDEX=<boolean> forces split-index mode on the whole
test suite. Accept any boolean values that are accepted by git-config.
GIT_TEST_PASSING_SANITIZE_LEAK=<boolean> when compiled with
SANITIZE=leak will run only those tests that have whitelisted
themselves as passing with no memory leaks. Tests can be whitelisted
by setting "TEST_PASSES_SANITIZE_LEAK=true" before sourcing
"test-lib.sh" itself at the top of the test script. This test mode is
used by the "linux-leaks" CI target.
GIT_TEST_PASSING_SANITIZE_LEAK=true skips those tests that haven't
declared themselves as leak-free by setting
"TEST_PASSES_SANITIZE_LEAK=true" before sourcing "test-lib.sh". This
test mode is used by the "linux-leaks" CI target.
GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'
default to n.

View File

@ -1447,7 +1447,6 @@ then
test_done
fi
# skip non-whitelisted tests when compiled with SANITIZE=leak
if test -n "$SANITIZE_LEAK"
then
if test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false