[docs] Update TestingGuide's note on how to run with Valgrind.
authorDaniel Dunbar <daniel@zuster.org>
Fri, 9 Aug 2013 19:39:48 +0000 (19:39 +0000)
committerDaniel Dunbar <daniel@zuster.org>
Fri, 9 Aug 2013 19:39:48 +0000 (19:39 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@188097 91177308-0d34-0410-b5e6-96231b3b80d8

docs/TestingGuide.rst

index 3cfbb219e6509c8d488b789fd0f2cbddc5827a1f..c74f52088928a3dba29e95348dfca499189edb4d 100644 (file)
@@ -120,12 +120,14 @@ can run the LLVM and Clang tests simultaneously using:
 
     % make check-all
 
-To run the tests with Valgrind (Memcheck by default), just append
-``VG=1`` to the commands above, e.g.:
+To run the tests with Valgrind (Memcheck by default), use the ``LIT_ARGS`` make
+variable to pass the required options to lit. For example, you can use:
 
 .. code-block:: bash
 
-    % make check VG=1
+    % make check LIT_ARGS="-v --vg --vg-leak"
+
+to enable testing with valgrind and with leak checking enabled.
 
 To run individual tests or subsets of tests, you can use the ``llvm-lit``
 script which is built as part of LLVM. For example, to run the