diff options
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r-- | docs/CommandGuide/FileCheck.rst | 19 | ||||
-rw-r--r-- | docs/CommandGuide/lit.rst | 33 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-cov.rst | 4 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-profdata.rst | 4 |
4 files changed, 50 insertions, 10 deletions
diff --git a/docs/CommandGuide/FileCheck.rst b/docs/CommandGuide/FileCheck.rst index 413b6f41b0cc..8830c394b212 100644 --- a/docs/CommandGuide/FileCheck.rst +++ b/docs/CommandGuide/FileCheck.rst @@ -77,6 +77,15 @@ OPTIONS -verify``. With this option FileCheck will verify that input does not contain warnings not covered by any ``CHECK:`` patterns. +.. option:: --enable-var-scope + + Enables scope for regex variables. + + Variables with names that start with ``$`` are considered global and + remain set throughout the file. + + All other variables get undefined after each encountered ``CHECK-LABEL``. + .. option:: -version Show the version number of this program. @@ -344,6 +353,9 @@ matched by the directive cannot also be matched by any other check present in other unique identifiers. Conceptually, the presence of ``CHECK-LABEL`` divides the input stream into separate blocks, each of which is processed independently, preventing a ``CHECK:`` directive in one block matching a line in another block. +If ``--enable-var-scope`` is in effect, all local variables are cleared at the +beginning of the block. + For example, .. code-block:: llvm @@ -436,6 +448,13 @@ were defined on. For example: Can be useful if you want the operands of ``op`` to be the same register, and don't care exactly which register it is. +If ``--enable-var-scope`` is in effect, variables with names that +start with ``$`` are considered to be global. All others variables are +local. All local variables get undefined at the beginning of each +CHECK-LABEL block. Global variables are not affected by CHECK-LABEL. +This makes it easier to ensure that individual tests are not affected +by variables set in preceding tests. + FileCheck Expressions ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/CommandGuide/lit.rst b/docs/CommandGuide/lit.rst index 7fc3455ddf69..b8299d44d48e 100644 --- a/docs/CommandGuide/lit.rst +++ b/docs/CommandGuide/lit.rst @@ -56,7 +56,7 @@ GENERAL OPTIONS Search for :file:`{NAME}.cfg` and :file:`{NAME}.site.cfg` when searching for test suites, instead of :file:`lit.cfg` and :file:`lit.site.cfg`. -.. option:: -D NAME, -D NAME=VALUE, --param NAME, --param NAME=VALUE +.. option:: -D NAME[=VALUE], --param NAME[=VALUE] Add a user defined parameter ``NAME`` with the given ``VALUE`` (or the empty string if not given). The meaning and use of these parameters is test suite @@ -152,6 +152,23 @@ SELECTION OPTIONS Run the tests in a random order. +.. option:: --num-shards=M + + Divide the set of selected tests into ``M`` equal-sized subsets or + "shards", and run only one of them. Must be used with the + ``--run-shard=N`` option, which selects the shard to run. The environment + variable ``LIT_NUM_SHARDS`` can also be used in place of this + option. These two options provide a coarse mechanism for paritioning large + testsuites, for parallel execution on separate machines (say in a large + testing farm). + +.. option:: --run-shard=N + + Select which shard to run, assuming the ``--num-shards=M`` option was + provided. The two options must be used together, and the value of ``N`` + must be in the range ``1..M``. The environment variable + ``LIT_RUN_SHARD`` can also be used in place of this option. + ADDITIONAL OPTIONS ------------------ @@ -362,7 +379,7 @@ PRE-DEFINED SUBSTITUTIONS ~~~~~~~~~~~~~~~~~~~~~~~~~~ :program:`lit` provides various patterns that can be used with the RUN command. -These are defined in TestRunner.py. +These are defined in TestRunner.py. The base set of substitutions are: ========== ============== Macro Substitution @@ -374,17 +391,13 @@ These are defined in TestRunner.py. %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`. +Other substitutions are provided that are variations on this base set and +further substitution patterns can be defined by each test module. See the +modules :ref:`local-configuration-files`. -More information on the testing infrastucture can be found in the +More detailed information on substitutions can be found in the :doc:`../TestingGuide`. TEST RUN OUTPUT FORMAT diff --git a/docs/CommandGuide/llvm-cov.rst b/docs/CommandGuide/llvm-cov.rst index 4c0354c0d608..ea2e625bc4d2 100644 --- a/docs/CommandGuide/llvm-cov.rst +++ b/docs/CommandGuide/llvm-cov.rst @@ -322,6 +322,10 @@ OPTIONS universal binary or to use an architecture that does not match a non-universal binary. +.. option:: -show-functions + + Show coverage summaries for each function. + .. program:: llvm-cov export .. _llvm-cov-export: diff --git a/docs/CommandGuide/llvm-profdata.rst b/docs/CommandGuide/llvm-profdata.rst index bae0ff7d4ce0..f7aa8309485b 100644 --- a/docs/CommandGuide/llvm-profdata.rst +++ b/docs/CommandGuide/llvm-profdata.rst @@ -196,6 +196,10 @@ OPTIONS Specify that the input profile is a sample-based profile. +.. option:: -memop-sizes + + Show the profiled sizes of the memory intrinsic calls for shown functions. + EXIT STATUS ----------- |