Skip to content

Commit ffd51c3

Browse files
author
Vasileios Karakasis
committed
Fine tune description of -J option
1 parent 761507b commit ffd51c3

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/manpage.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -337,15 +337,19 @@ Options controlling job submission
337337
.. option:: -J, --job-option=OPTION
338338

339339
Pass ``OPTION`` directly to the job scheduler backend.
340-
The syntax for this option is ``-J key=value``.
341-
If ``key`` starts with ``-`` or ``#``, the option will be passed verbatim to the job script.
342-
Otherwise, ReFrame will add ``-`` or ``--`` as well as the directive corresponding to the current scheduler.
343-
This option will be emitted after any options specified in the :js:attr:`access` system partition configuration parameter.
344-
Especially for the Slurm scheduler, constraint options, i.e ``-J constraint=value``, ``-J C=value``, ``-J --constraint=value``, ``-J -C=value` are going to be combined with the corresponding ones specified in the :js:attr:`access` system partition configuration parameter.
345-
If multiple constraint options are specified with separate key-value pairs, only the last one is going to be taken into account.
346-
For multiple combined constraints use the ``-J constraint=value1,value2`` syntax.
347-
Note that the above is not valid if ``key`` starts with ``#`` in which case the option is going to be passed verbatim to the job script.
348-
340+
The syntax of ``OPTION`` is ``-J key=value``.
341+
If ``OPTION`` starts with ``-`` it will be passed verbatim to the backend job scheduler.
342+
If ``OPTION`` starts with ``#`` it will be emitted verbatim in the job script.
343+
Otherwise, ReFrame will pass ``--key=value`` or ``-k value`` (if ``key`` is a single character) to the backend scheduler.
344+
Any job options specified with this command-line option will be emitted after any job options specified in the :js:attr:`access` system partition configuration parameter.
345+
346+
Especially for the Slurm backends, constraint options, such as ``-J constraint=value``, ``-J C=value``, ``-J --constraint=value`` or ``-J -C=value``, are going to be combined with any constraint options specified in the :js:attr:`access` system partition configuration parameter.
347+
For example, if ``-C x`` is specified in the :js:attr:`access` and ``-J C=y`` is passed to the command-line, ReFrame will pass ``-C x,y`` as a constraint to the scheduler.
348+
Notice, however, that if constraint options are specified through multiple :option:`-J` options, only the last one will be considered.
349+
If you wish to completely overwrite any constraint options passed in :js:attr:`access`, you should consider passing explicitly the Slurm directive with ``-J '#SBATCH --constraint=new'``.
350+
351+
.. versionchanged:: 3.0
352+
This option has become more flexible.
349353

350354
------------------------
351355
Flexible node allocation

0 commit comments

Comments
 (0)