Skip to content

Commit 9432d15

Browse files
committed
[docs] use "=" in options with arguments
This is a fixup for llvm#141851 and consistently applies the "=" to all options with additional arguments. Before 14 out of 22 options with arguments used "=" and 7 didn't.
1 parent 3297340 commit 9432d15

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

llvm/docs/CommandGuide/lit.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ OUTPUT OPTIONS
112112

113113
Enable -v, but for all tests not just failed tests.
114114

115-
.. option:: -o PATH, --output PATH
115+
.. option:: -o=PATH, --output=PATH
116116

117117
Write test results to the provided path.
118118

@@ -187,23 +187,23 @@ EXECUTION OPTIONS
187187

188188
Don't execute any tests (assume that they pass).
189189

190-
.. option:: --xunit-xml-output XUNIT_XML_OUTPUT
190+
.. option:: --xunit-xml-output=XUNIT_XML_OUTPUT
191191

192192
Write XUnit-compatible XML test reports to the specified file.
193193

194194
.. option:: --report-failures-only
195195

196196
Only include failures (see :ref:`test-status-results`) in the report.
197197

198-
.. option:: --resultdb-output RESULTDB_OUTPUT
198+
.. option:: --resultdb-output=RESULTDB_OUTPUT
199199

200200
Write LuCI ResultDB compatible JSON to the specified file.
201201

202-
.. option:: --time-trace-output TIME_TRACE_OUTPUT
202+
.. option:: --time-trace-output=TIME_TRACE_OUTPUT
203203

204204
Write Chrome tracing compatible JSON to the specified file
205205

206-
.. option:: --timeout MAXINDIVIDUALTESTTIME
206+
.. option:: --timeout=MAXINDIVIDUALTESTTIME
207207

208208
Maximum time to spend running a single test (in seconds). 0 means no time
209209
limit. [Default: 0]
@@ -214,11 +214,11 @@ EXECUTION OPTIONS
214214
``0`` means no time limit, and ``0`` is the default. Note that this is not an
215215
alias for :option:`--max-time`; the two are different kinds of maximums.
216216

217-
.. option:: --max-failures MAX_FAILURES
217+
.. option:: --max-failures=MAX_FAILURES
218218

219219
Stop execution after the given number of failures.
220220

221-
.. option:: --max-retries-per-test N
221+
.. option:: --max-retries-per-test=N
222222

223223
Retry running failed tests at most ``N`` times.
224224
Out of the following options to rerun failed tests the

0 commit comments

Comments
 (0)