llvm.org GIT mirror llvm / 56b920f
[docs] cleanup documentation on lit substitutions 1. Added missing substitutions to the documentation in docs/TestingGuide.rst 2. Modified docs/CommandGuide/lit.rst to only document the "base" set of substitutions and to refer the reader to docs/TestingGuide.rst for more detailed info on substitutions. Patch by bd1976llvm Differential Revision: https://reviews.llvm.org/D29281 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@294586 91177308-0d34-0410-b5e6-96231b3b80d8 David Bozier 2 years ago
2 changed file(s) with 25 addition(s) and 10 deletion(s). Raw diff Collapse all Expand all
378378 ~~~~~~~~~~~~~~~~~~~~~~~~~~
379379
380380 :program:`lit` provides various patterns that can be used with the RUN command.
381 These are defined in TestRunner.py.
381 These are defined in TestRunner.py. The base set of substitutions are:
382382
383383 ========== ==============
384384 Macro Substitution
390390 %t temporary file name unique to the test
391391 %T temporary directory unique to the test
392392 %% %
393 %/s same as %s but replace all / with \\
394 %/S same as %S but replace all / with \\
395 %/p same as %p but replace all / with \\
396 %/t same as %t but replace all / with \\
397 %/T same as %T but replace all / with \\
398393 ========== ==============
399394
400 Further substitution patterns might be defined by each test module.
401 See the modules :ref:`local-configuration-files`.
402
403 More information on the testing infrastucture can be found in the
395 Other substitutions are provided that are variations on this base set and
396 further substitution patterns can be defined by each test module. See the
397 modules :ref:`local-configuration-files`.
398
399 More detailed information on substitutions can be found in the
404400 :doc:`../TestingGuide`.
405401
406402 TEST RUN OUTPUT FORMAT
467467
468468 Expands to the path separator, i.e. ``:`` (or ``;`` on Windows).
469469
470 ``%/s, %/S, %/t, %/T:``
471
472 Act like the corresponding substitution above but replace any ``\``
473 character with a ``/``. This is useful to normalize path separators.
474
475 Example: ``%s: C:\Desktop Files/foo_test.s.tmp``
476
477 Example: ``%/s: C:/Desktop Files/foo_test.s.tmp``
478
479 ``%:s, %:S, %:t, %:T:``
480
481 Act like the corresponding substitution above but remove colons at
482 the beginning of Windows paths. This is useful to allow concatenation
483 of absolute paths on Windows to produce a legal path.
484
485 Example: ``%s: C:\Desktop Files\foo_test.s.tmp``
486
487 Example: ``%:s: C\Desktop Files\foo_test.s.tmp``
488
470489
471490 **LLVM-specific substitutions:**
472491