From: Matthias Braun <matze@braunis.de>
Date: Mon, 4 May 2015 21:37:00 +0000 (+0000)
Subject: Document some of the options in test/lit.cfg
X-Git-Tag: llvmorg-3.7.0-rc1~5418
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=29f3f1163f301ef2345332779c9cf7a204eac6ec;p=platform%2Fupstream%2Fllvm.git

Document some of the options in test/lit.cfg

llvm-svn: 236462
---

diff --git a/llvm/docs/TestingGuide.rst b/llvm/docs/TestingGuide.rst
index 3463156495a9..adf5f3d4cfbd 100644
--- a/llvm/docs/TestingGuide.rst
+++ b/llvm/docs/TestingGuide.rst
@@ -473,6 +473,25 @@ RUN lines:
 To add more substituations, look at ``test/lit.cfg`` or ``lit.local.cfg``.
 
 
+Options
+-------
+
+The llvm lit configuration allows to customize some things with user options:
+
+``llc``, ``opt``, ...
+    Substitute the respective llvm tool name with a custom command line. This
+    allows to specify custom paths and default arguments for these tools.
+    Example:
+
+    % llvm-lit "-Dllc=llc -verify-machineinstrs"
+
+``run_long_tests``
+    Enable the execution of long running tests.
+
+``llvm_site_config``
+    Load the specified lit configuration instead of the default one.
+
+
 Other Features
 --------------