Skip to content

[docs] don't use "=" in lit options with arguments #142340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 4, 2025
+14 −14
Merged

[docs] don't use "=" in lit options with arguments #142340

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d28919
[lit] don't use "=" in lit options with arguments
kwk Jun 2, 2025
a94dc1a
Merge branch 'main' into fixup-for-141851
kwk Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions llvm/docs/CommandGuide/lit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ GENERAL OPTIONS

Show :program:`lit`'s version number and exit.

.. option:: -j N, --workers=N
.. option:: -j N, --workers N

Run ``N`` tests in parallel. By default, this is automatically chosen to
match the number of detected available CPUs.

.. option:: --config-prefix=NAME
.. option:: --config-prefix NAME

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`.
Expand Down Expand Up @@ -157,7 +157,7 @@ EXECUTION OPTIONS

Disable sharding for GoogleTest format.

.. option:: --path=PATH
.. option:: --path PATH

Specify an additional ``PATH`` to use when searching for executables in tests.

Expand All @@ -178,7 +178,7 @@ EXECUTION OPTIONS
feature that can be used to conditionally disable (or expect failure in)
certain tests.

.. option:: --vg-arg=ARG
.. option:: --vg-arg ARG

When :option:`--vg` is used, specify an additional argument to pass to
:program:`valgrind` itself.
Expand Down Expand Up @@ -208,7 +208,7 @@ EXECUTION OPTIONS
Maximum time to spend running a single test (in seconds). 0 means no time
limit. [Default: 0]

.. option:: --timeout=N
.. option:: --timeout N

Spend at most ``N`` seconds (approximately) running each individual test.
``0`` means no time limit, and ``0`` is the default. Note that this is not an
Expand Down Expand Up @@ -268,17 +268,17 @@ The timing data is stored in the `test_exec_root` in a file named
`.lit_test_times.txt`. If this file does not exist, then `lit` checks the
`test_source_root` for the file to optionally accelerate clean builds.

.. option:: --max-tests=N
.. option:: --max-tests N

Run at most ``N`` tests and then terminate.

.. option:: --max-time=N
.. option:: --max-time N

Spend at most ``N`` seconds (approximately) running tests and then terminate.
Note that this is not an alias for :option:`--timeout`; the two are
different kinds of maximums.

.. option:: --order={lexical,random,smart}
.. option:: --order {lexical,random,smart}

Define the order in which tests are run. The supported values are:

Expand All @@ -300,21 +300,21 @@ The timing data is stored in the `test_exec_root` in a file named

Run failed tests first (DEPRECATED: use ``--order=smart``).

.. option:: --filter=REGEXP
.. option:: --filter REGEXP

Run only those tests whose name matches the regular expression specified in
``REGEXP``. The environment variable ``LIT_FILTER`` can be also used in place
of this option, which is especially useful in environments where the call
to ``lit`` is issued indirectly.

.. option:: --filter-out=REGEXP
.. option:: --filter-out REGEXP

Filter out those tests whose name matches the regular expression specified in
``REGEXP``. The environment variable ``LIT_FILTER_OUT`` can be also used in
place of this option, which is especially useful in environments where the
call to ``lit`` is issued indirectly.

.. option:: --xfail=LIST
.. option:: --xfail LIST

Treat those tests whose name is in the semicolon separated list ``LIST`` as
``XFAIL``. This can be helpful when one does not want to modify the test
Expand Down Expand Up @@ -346,7 +346,7 @@ The timing data is stored in the `test_exec_root` in a file named

LIT_XFAIL="affinity/kmp-hw-subset.c;libomptarget :: x86_64-pc-linux-gnu :: offloading/memory_manager.cpp"

.. option:: --xfail-not=LIST
.. option:: --xfail-not LIST

Do not treat the specified tests as ``XFAIL``. The environment variable
``LIT_XFAIL_NOT`` can also be used in place of this option. The syntax is the
Expand All @@ -356,7 +356,7 @@ The timing data is stored in the `test_exec_root` in a file named
primary purpose is to suppress an ``XPASS`` result without modifying a test
case that uses the ``XFAIL`` directive.

.. option:: --num-shards=M
.. 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
Expand All @@ -366,7 +366,7 @@ The timing data is stored in the `test_exec_root` in a file named
testsuites, for parallel execution on separate machines (say in a large
testing farm).

.. option:: --run-shard=N
.. 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``
Expand Down
Loading