Skip to content

Commit ac8e3e9

Browse files
avargitster
authored andcommitted
t/README: reword the "GIT_TEST_PASSING_SANITIZE_LEAK" description
Reword the documentation added in 956d2e4 (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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 46fb057 commit ac8e3e9

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

t/README

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -366,12 +366,10 @@ excluded as so much relies on it, but this might change in the future.
366366
GIT_TEST_SPLIT_INDEX=<boolean> forces split-index mode on the whole
367367
test suite. Accept any boolean values that are accepted by git-config.
368368

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.
375373

376374
GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'
377375
default to n.

t/test-lib.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1447,7 +1447,6 @@ then
14471447
test_done
14481448
fi
14491449

1450-
# skip non-whitelisted tests when compiled with SANITIZE=leak
14511450
if test -n "$SANITIZE_LEAK"
14521451
then
14531452
if test_bool_env GIT_TEST_PASSING_SANITIZE_LEAK false

0 commit comments

Comments
 (0)