[llvm] r265314 - Document standard substitutions defined by lit.

[Paul Robinson via llvm-commits]

Author: probinson
Date: Mon Apr  4 12:14:45 2016
New Revision: 265314

URL: http://llvm.org/viewvc/llvm-project?rev=265314&view=rev
Log:
Document standard substitutions defined by lit.

Patch by Guilherme Bufolo!

Differential Revision: http://reviews.llvm.org/D18752

Modified:
    llvm/trunk/docs/CommandGuide/lit.rst

Modified: llvm/trunk/docs/CommandGuide/lit.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/lit.rst?rev=265314&r1=265313&r2=265314&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/lit.rst (original)
+++ llvm/trunk/docs/CommandGuide/lit.rst Mon Apr  4 12:14:45 2016
@@ -355,6 +355,35 @@ be used to define subdirectories of opti
 configuration parameters --- for example, to change the test format, or the
 suffixes which identify test files.
 
+PRE-DEFINED SUBSTITUTIONS
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:program:`lit` provides various patterns that can be used with the RUN command.
+These are defined in TestRunner.py.
+
+ ========== ==============
+  Macro      Substitution
+ ========== ==============
+ %s         source path (path to the file currently being run)
+ %S         source dir (directory of the file currently being run)
+ %p         same as %S
+ %{pathsep} path separator
+ %t         temporary file name unique to the test
+ %T         temporary directory unique to the test
+ %%         %
+ %/s        same as %s but replace all / with \\
+ %/S        same as %S but replace all / with \\
+ %/p        same as %p but replace all / with \\
+ %/t        same as %t but replace all / with \\
+ %/T        same as %T but replace all / with \\
+ ========== ==============
+
+Further substitution patterns might be defined by each test module.
+See the modules :ref:`local-configuration-files`.
+
+More information on the testing infrastucture can be found in the
+:doc:`../TestingGuide`.
+
 TEST RUN OUTPUT FORMAT
 ~~~~~~~~~~~~~~~~~~~~~~