Skip to content

[doc] Add note in docs about the scope of target_systems #3674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vkarak wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

[doc] Add note in docs about the scope of target_systems #3674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/config_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1247,6 +1247,9 @@ You may define different logger objects per system but *not* per partition.
A list of systems or system/partitions combinations that this logging configuration is valid for.
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.

.. note::
The scope of all logging options is system-wide, so only system names can be specified in this list, otherwise the scope will be ignored.



Common logging handler properties
Expand Down Expand Up @@ -1887,6 +1890,9 @@ The options of an execution mode will be passed to ReFrame as if they were speci
A list of systems *only* that this execution mode is valid for.
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.

.. note::
The scope of all modes options is system-wide, so only system names can be specified in this list, otherwise the scope will be ignored.


.. _storage-configuration:

Expand Down Expand Up @@ -1948,6 +1954,9 @@ Result storage configuration

For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.

.. note::
The scope of all storage options is system-wide, so only system names can be specified in this list, otherwise the scope will be ignored.


.. _general-configuration:

Expand Down Expand Up @@ -2312,6 +2321,15 @@ General Configuration
A list of systems or system/partitions combinations that these general options are valid for.
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.

.. note::
The scope of all general options is system-wide, so only system names can be specified in this list, otherwise the scope will be ignored.
Exception to this rule are the following options, which have a partition scope:

- :attr:`~general.git_timeout`
- :attr:`~general.use_login_shell`
- :attr:`~general.flex_alloc_strict`
- :attr:`~general.trap_job_errors`


.. py:attribute:: general.table_format

Expand Down
Loading