[llvm] b3f1682 - [docs] Document lit's --timeout=N flag

[Jon Roelofs via llvm-commits]

Author: Jon Roelofs
Date: 2020-04-22T12:57:25-06:00
New Revision: b3f168274d8fee531af6d28d5977ffad119f7791

URL: https://github.com/llvm/llvm-project/commit/b3f168274d8fee531af6d28d5977ffad119f7791
DIFF: https://github.com/llvm/llvm-project/commit/b3f168274d8fee531af6d28d5977ffad119f7791.diff

LOG: [docs] Document lit's --timeout=N flag

Added: 
    

Modified: 
    llvm/docs/CommandGuide/lit.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/lit.rst b/llvm/docs/CommandGuide/lit.rst
index bbd739f28d42..86f1fdae3b6a 100644
--- a/llvm/docs/CommandGuide/lit.rst
+++ b/llvm/docs/CommandGuide/lit.rst
@@ -165,10 +165,8 @@ SELECTION OPTIONS
 .. option:: --max-time=N
 
  Spend at most ``N`` seconds (approximately) running tests and then terminate.
-
-.. option:: --shuffle
-
- Run the tests in a random order.
+ Note that this is not an alias for :option:``--timeout=N``; the two are
+ 
diff erent kinds of maximums.
 
 .. option:: --num-shards=M
 
@@ -187,6 +185,16 @@ SELECTION OPTIONS
  must be in the range ``1..M``. The environment variable
  ``LIT_RUN_SHARD`` can also be used in place of this option.
 
+.. option:: --shuffle
+
+ Run the tests in a random order.
+
+.. 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
+ alias for :option:``--max-time=N``; the two are 
diff erent kinds of maximums.
+
 .. option:: --filter=REGEXP
 
   Run only those tests whose name matches the regular expression specified in