Skip to content

Commit 1eef8b5

Browse files
author
Vasileios Karakasis
committed
Update documentation
1 parent 212cd8b commit 1eef8b5

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

docs/manpage.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -384,20 +384,28 @@ Options controlling ReFrame execution
384384
Distribute the selected tests on all the nodes in state ``NODESTATE`` in their respective valid partitions.
385385

386386
ReFrame will parameterize and run the tests on the selected nodes.
387-
In order to do that, it will dynamically create new tests that will inherit all the attributes of the original tests and contain one more parameter, ``$nid``, with the node that it will run on.
388-
The new ReFrame classes are named ``{basetest}_{partition}``.
387+
Effectively, it will dynamically create new tests that inherit from the original tests and add a new parameter named ``$nid`` which contains the list of nodes that the test must run on.
388+
The new tests are named with the following pattern ``{orig_test_basename}_{partition_fullname}``.
389389

390-
Currently this will work correctly only for one-node tests in local or Slurm partitions, and it will take into account the cli jobs options that are passed by the user.
391-
This feature will not work with dependencies, since the names of the tests will be changed, but it will work with fixtures.
390+
When determining the list of nodes to distribute the selected tests, ReFrame will take into account any job options passed through the :option:`-J` option.
392391

393-
You can decide the state of the nodes that will be considered:
392+
You can optionally specify the state of the nodes to consider when distributing the test through the ``NODESTATE`` argument:
394393

395-
- ``all``: Tests will be parameterized over all the nodes of their partitions.
396-
- ``NODESTATE``: Tests will run on all the nodes in state ``NODESTATE``, for example ``idle``.
397-
The states of the nodes will be determined once, before beginning the
398-
execution of the tests so it might be different in the time of the submission of the tests.
394+
- ``all``: Tests will run on all the nodes of their respective valid partitions regardless of the nodes' state.
395+
- ``idle``: Tests will run on all *idle* nodes of their respective valid partitions.
396+
- ``NODESTATE``: Tests will run on all the nodes in state ``NODESTATE`` of their respective valid partitions.
397+
If ``NODESTATE`` is not specified, ``idle`` will be assumed.
398+
399+
The state of the nodes will be determined once, before beginning the
400+
execution of the tests, so it might be different at the time the tests are actually submitted.
401+
402+
.. note::
403+
Currently, only single-node jobs can be distributed and only local or the Slurm-based backends support this feature.
404+
405+
.. note::
406+
Distributing tests with dependencies is not supported.
407+
However, you can distribute tests that use fixtures.
399408

400-
If ``NODESTATE`` is not passed it will take ``idle`` as default.
401409

402410
.. versionadded:: 3.11.0
403411

0 commit comments

Comments
 (0)