From: Carlos Martín Nieto <cmn@elego.de>
Date: Tue, 15 Mar 2011 09:32:11 +0000 (+0100)
Subject: t/README: Add a note about running commands under valgrind
X-Git-Tag: v1.7.4.2~11
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9aec68d3ea935fcb778a3580d950cf20d5bd35f6;p=git.git

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

diff --git a/t/README b/t/README
index 78c9e6575..d44a614ea 100644
--- a/t/README
+++ b/t/README
@@ -98,6 +98,13 @@ appropriately before running "make".
 	not see any output, this option implies --verbose.  For
 	convenience, it also implies --tee.
 
+	Note that valgrind is run with the option --leak-check=no,
+	as the git process is short-lived and some errors are not
+	interesting. In order to run a single command under the same
+	conditions manually, you should set GIT_VALGRIND to point to
+	the 't/valgrind/' directory and use the commands under
+	't/valgrind/bin/'.
+
 --tee::
 	In addition to printing the test output to the terminal,
 	write it to files named 't/test-results/$TEST_NAME.out'.