Skip to content

Commit 95c696d

Browse files
committed
add config documentation
1 parent ee0d711 commit 95c696d

File tree

1 file changed

+36
-13
lines changed

1 file changed

+36
-13
lines changed

docs/source/user/configuration.sections.rst

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,47 @@ Set general configuration settings.
2020
debug: false # (bool)
2121
log_level: "INFO" # (str)
2222
23-
batch
24-
-----
23+
config:multiprocessing
24+
......................
2525

26-
Set batch settings.
26+
Multiprocessing configuration settings
2727

2828
.. code-block:: yaml
2929
30-
batch:
31-
duration: 1800 # (float)
32-
default_options: [] # (list of str)
30+
config:
31+
multiprocessing:
32+
context: spawn
33+
max_tasks_per_child: 1
3334
34-
plugins
35-
-------
35+
config:plugins
36+
..............
3637

3738
Plugins to load
3839

3940
.. code-block:: yaml
4041
41-
plugins: [] # (list of str)
42+
config:
43+
plugins: [] # (list of str)
44+
45+
config:polling_frequency
46+
........................
47+
48+
Frequency to poll running tests from completion
49+
50+
.. code-block:: yaml
51+
52+
config:
53+
polling_freqeuncy:
54+
testcase: 0.05
4255
43-
test:timeout
44-
------------
56+
config:timeout
57+
..............
4558

4659
Set test timeouts based on :ref:`keywords<directive-keywords>`. The ``fast`` and ``long`` timeouts are applied to tests having ``fast`` or ``long`` :ref:`keywords<directive-keywords>`, otherwise the ``default`` timeout is applied.
4760

4861
.. code-block:: yaml
4962
50-
test:
63+
config:
5164
timeout:
5265
fast: T # (number or str) default: 30s
5366
long: T # (number or str) default: 10m
@@ -59,12 +72,22 @@ Set test timeouts based on :ref:`keywords<directive-keywords>`. The ``fast`` an
5972

6073
.. code-block:: yaml
6174
62-
test:
75+
config:
6376
timeout:
6477
unit_test: 1s
6578
6679
The same can be accomplished on the command line: ``canary -c test:timeout:unit_test:1s ...``.
6780

81+
batch
82+
-----
83+
84+
Set batch settings.
85+
86+
.. code-block:: yaml
87+
88+
batch:
89+
default_options: [] # (list of str)
90+
6891
environment
6992
-----------
7093

0 commit comments

Comments
 (0)