Documented standard substitutions defined by lit

[MatzeB]

Most patterns and several of the ones coming from lit.local.cfg are explained in TestingGuide.rst as well. On the other hand it makes sense to explain the lit specific substitutions in the lit docu, maybe just add an additional link to the TestingGuide.rst to reference this section for additional lit flags?

[RedX2501]

Added reference to testing infrastructure document.

[MatzeB]

I'd probably go for a term like "pattern" instead of macro (there is no parameters or anything more complicated). The explanation for %t/%T is not helpful in the current form. Maybe something like 'temporary file name unique to the test'/'temporary directory unique to the test'.

Apart from that LGTM.

[RedX2501]

I had a hard time myself figuring out what tmpbase and tmpdir are. I have used your wording.

Somebody else needs to commit this as I don't have any rights for it.

[probinson]

In D18752#390906, @RedX2501 wrote:

Somebody else needs to commit this as I don't have any rights for it.

When someone else commits for you, our practice is to attribute the correct author in the commit message.
This is more than a courtesy, because you retain copyright of any changes you have made. Therefore we prefer to use your actual name rather than a handle such as RedX2501, guibufolo, or Guilherme.
What name would you like us to use?

[RedX2501]

Thanks for the advice.

Please use Guilherme Bufolo as the name for the commit.
Am 04.04.2016 21:33 schrieb "Paul Robinson" <
[e-mail]>:

probinson added a subscriber: probinson.
probinson added a comment.

In http://reviews.llvm.org/D18752#390906, @RedX2501 wrote:

Somebody else needs to commit this as I don't have any rights for it.

When someone else commits for you, our practice is to attribute the
correct author in the commit message.
This is more than a courtesy, because you retain copyright of any changes
you have made. Therefore we prefer to use your actual name rather than a
handle such as RedX2501, guibufolo, or Guilherme.
What name would you like us to use?

http://reviews.llvm.org/D18752

llvm/trunk/docs/CommandGuide/lit.rst

 --- the root of this configuration chain will always be a test suite.  Once the
 test configuration is cloned :program:`lit` checks for a *lit.local.cfg* file
 in the subdirectory.  If present, this file will be loaded and can be used to
 specialize the configuration for each individual directory.  This facility can
 be used to define subdirectories of optional tests, or to change other
 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
 ~~~~~~~~~~~~~~~~~~~~~~
 
 The :program:`lit` output for a test run conforms to the following schema, in
 both short and verbose modes (although in short mode no PASS lines will be
 shown).  This schema has been chosen to be relatively easy to reliably parse by
 a machine (for example in buildbot log scraping), and for other tools to
 generate.