This is an archive of the discontinued LLVM Phabricator instance.

Differential D81337

Add max-failures option to lit documentation
ClosedPublic

Authored by sqlbyme on Jun 6 2020, 5:01 PM.

Details

Reviewers
cmatthews
Commits
rG972a73a34786: [LIT] NFC adding max-failures option to lit documentation.
Summary

The max-failures option is not listed in the online documentation. I thought we should fix that.

Diff Detail

Event Timeline

sqlbyme created this revision.Jun 6 2020, 5:01 PM
Herald added a subscriber: llvm-commits. · View Herald TranscriptJun 6 2020, 5:01 PM
Harbormaster completed remote builds in B59381: Diff 269034.Jun 6 2020, 5:36 PM
cmatthews accepted this revision.Jun 6 2020, 5:38 PM

Good idea!

This revision is now accepted and ready to land.Jun 6 2020, 5:38 PM
Closed by commit rG972a73a34786: [LIT] NFC adding max-failures option to lit documentation. (authored by sqlbyme). · Explain WhyJun 6 2020, 6:40 PM
This revision was automatically updated to reflect the committed changes.
jdenny added a subscriber: jdenny.Jun 8 2020, 8:17 AM
jdenny added inline comments.
llvm/docs/CommandGuide/lit.rst
165

vairable -> variable

Also, does a MAX_FAILURES environment variable exist? git grep MAX_FAILURES doesn't find it.

jdenny added subscribers: yln, probinson, ldionne, rnk.Jun 19 2020, 10:18 AM
jdenny added inline comments.
llvm/docs/CommandGuide/lit.rst
165

Ping.

yln added inline comments.Jun 19 2020, 11:00 AM
llvm/docs/CommandGuide/lit.rst
165

AFAIK, lit does not respect a MAX_FAILURES env var. One can do: LIT_OPTS=--max-failures=10. I think we can remove the last sentence from the description.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
7 lines

Diff 269035

llvm/docs/CommandGuide/lit.rst

Show First 20 Lines • Show All 152 Lines • ▼ Show 20 Lines
suite take the most time to execute. Note that this option is most useful suite take the most time to execute. Note that this option is most useful
with ``-j 1``. with ``-j 1``.
.. _selection-options: .. _selection-options:
SELECTION OPTIONS SELECTION OPTIONS
----------------- -----------------
.. option:: --max-failures MAX_FAILURES
Stop execution after the given number of failures.
An integer argument may be passed on the command line
or the environment vairable MAX_FAILURES may be set
jdennyUnsubmitted
Not Done
ReplyInline Actions

vairable -> variable

Also, does a MAX_FAILURES environment variable exist? git grep MAX_FAILURES doesn't find it.

jdenny: vairable -> variable Also, does a `MAX_FAILURES` environment variable exist? `git grep…
jdennyUnsubmitted
Not Done
ReplyInline Actions

Ping.

jdenny: Ping.
ylnUnsubmitted
Not Done
ReplyInline Actions

AFAIK, lit does not respect a MAX_FAILURES env var. One can do: LIT_OPTS=--max-failures=10. I think we can remove the last sentence from the description.

yln: AFAIK, lit does not respect a `MAX_FAILURES` env var. One can do: `LIT_OPTS=--max-failures=10`.
prior to execution.
.. option:: --max-tests=N .. option:: --max-tests=N
Run at most ``N`` tests and then terminate. 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. Spend at most ``N`` seconds (approximately) running tests and then terminate.
Note that this is not an alias for :option:`--timeout`; the two are Note that this is not an alias for :option:`--timeout`; the two are
▲ Show 20 Lines • Show All 369 Lines • Show Last 20 Lines