t/README: Add a note about running commands under valgrind
The test suite runs valgrind with certain options activated. Add a note saying how to run commands under the same conditions as the test suite does. Signed-off-by: Carlos Martín Nieto <cmn@elego.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Carlos Martín Nieto committed
Mar 15, 2011 at 10:32 UTC
9aec68d3ea935fcb778a3580d950cf20d5bd35f6
1 file changed
+7
t/README
+7
@@ -98,6 +98,13 @@ appropriately before running "make".
98
not see any output, this option implies --verbose. For
99
convenience, it also implies --tee.
100
101
+ Note that valgrind is run with the option --leak-check=no,
102
+ as the git process is short-lived and some errors are not
103
+ interesting. In order to run a single command under the same
104
+ conditions manually, you should set GIT_VALGRIND to point to
105
+ the 't/valgrind/' directory and use the commands under
106
+ 't/valgrind/bin/'.
107
+
108
--tee::
109
In addition to printing the test output to the terminal,
110
write it to files named 't/test-results/$TEST_NAME.out'.