[docs] Document the --junit4-timeout option

[skip ci]
repobee · Dec 4, 2019 · 9760324 · 9760324
1 parent 0d885e9
commit 9760324
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/install.rst b/docs/install.rst
@@ -74,6 +74,7 @@ to the end of the configuration file. Here's a sample configuration.
    junit_path = /absolute/path/to/junit-4.12.jar
    hamcrest_path = /absolute/path/to/hamcrest-core-1.3.jar
    reference_tests_dir = /absolute/path/to/reference_tests_dir
+   timeout = 5
 
 .. important::
 

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -69,6 +69,10 @@ command.
     - Long lines are truncated.
 * ``--junit4-very-verbose``
     - Same as ``--junit4-verbose``, but without truncation.
+* ``--junit4-timeout``
+    - The maximum amount of time a test class is allowed to run before timing
+      out. Defaults to a sane value.
+    - Can be specified in the config file with the ``timeout`` option.
 
 .. _use case: