Skip to content

Commit 107d8c7

Browse files
authored
[docs] don't use "=" in lit options with arguments (#142340)
This is a fixup for #141851 and removes `=` from all options with additional arguments. Before 14 out of 22 options with arguments used "=" and 7 didn't.
1 parent 7214a3d commit 107d8c7

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

llvm/docs/CommandGuide/lit.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ GENERAL OPTIONS
6363

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

66-
.. option:: -j N, --workers=N
66+
.. option:: -j N, --workers N
6767

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

71-
.. option:: --config-prefix=NAME
71+
.. option:: --config-prefix NAME
7272

7373
Search for :file:`{NAME}.cfg` and :file:`{NAME}.site.cfg` when searching for
7474
test suites, instead of :file:`lit.cfg` and :file:`lit.site.cfg`.
@@ -157,7 +157,7 @@ EXECUTION OPTIONS
157157

158158
Disable sharding for GoogleTest format.
159159

160-
.. option:: --path=PATH
160+
.. option:: --path PATH
161161

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

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

181-
.. option:: --vg-arg=ARG
181+
.. option:: --vg-arg ARG
182182

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

211-
.. option:: --timeout=N
211+
.. option:: --timeout N
212212

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

271-
.. option:: --max-tests=N
271+
.. option:: --max-tests N
272272

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

275-
.. option:: --max-time=N
275+
.. option:: --max-time N
276276

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

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

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

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

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

303-
.. option:: --filter=REGEXP
303+
.. option:: --filter REGEXP
304304

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

310-
.. option:: --filter-out=REGEXP
310+
.. option:: --filter-out REGEXP
311311

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

317-
.. option:: --xfail=LIST
317+
.. option:: --xfail LIST
318318

319319
Treat those tests whose name is in the semicolon separated list ``LIST`` as
320320
``XFAIL``. This can be helpful when one does not want to modify the test
@@ -346,7 +346,7 @@ The timing data is stored in the `test_exec_root` in a file named
346346
347347
LIT_XFAIL="affinity/kmp-hw-subset.c;libomptarget :: x86_64-pc-linux-gnu :: offloading/memory_manager.cpp"
348348
349-
.. option:: --xfail-not=LIST
349+
.. option:: --xfail-not LIST
350350

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

359-
.. option:: --num-shards=M
359+
.. option:: --num-shards M
360360

361361
Divide the set of selected tests into ``M`` equal-sized subsets or
362362
"shards", and run only one of them. Must be used with the
@@ -366,7 +366,7 @@ The timing data is stored in the `test_exec_root` in a file named
366366
testsuites, for parallel execution on separate machines (say in a large
367367
testing farm).
368368

369-
.. option:: --run-shard=N
369+
.. option:: --run-shard N
370370

371371
Select which shard to run, assuming the ``--num-shards=M`` option was
372372
provided. The two options must be used together, and the value of ``N``

0 commit comments

Comments
 (0)