You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config_reference.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ The full schema describing it can be found in |schemas/config.json|_ file.
11
11
The final configuration for ReFrame is validated against this schema.
12
12
13
13
The syntax we use to describe the different configuration objects follows the convention: ``OBJECT[.OBJECT]*.PROPERTY``.
14
-
Even if a configuration object contains a list of other object, this is not reflected in the above syntax, as all objects in a certain list are homogeneous.
14
+
Even if a configuration object contains a list of other objects, this is not reflected in the above syntax, as all objects in a certain list are homogeneous.
15
15
For example, by ``systems.partitions.name`` we designate the ``name`` property of any partition object inside the ``partitions`` property of any system object inside the top level ``systems`` object.
16
16
If we were to use indices, that would be rewritten as ``systems[i].partitions[j].name`` where ``i`` indexes the systems and ``j`` indexes the partitions of the i-th system.
17
17
For cases, where the objects in a list are not homogeneous, e.g., the logging handlers, we surround the object type with ``..``.
@@ -25,7 +25,7 @@ Top-level Configuration
25
25
-----------------------
26
26
27
27
The top-level configuration object is essentially the full configuration of ReFrame.
28
-
It consists of the following properties, which also call conventionally *configuration sections*:
28
+
It consists of the following properties, which we also call conventionally *configuration sections*:
29
29
30
30
.. py:data:: systems
31
31
@@ -671,7 +671,7 @@ ReFrame allows you to define custom scheduler resources for each partition that
671
671
]
672
672
673
673
674
-
A regression test that wants to make use of that resource, it can set its :attr:`~reframe.core.pipeline.RegressionTest.extra_resources` as follows:
674
+
A regression test that needs to make use of that resource, it can set its :attr:`~reframe.core.pipeline.RegressionTest.extra_resources` as follows:
675
675
676
676
.. code:: python
677
677
@@ -916,7 +916,7 @@ You may define different logger objects per system but *not* per partition.
916
916
:default: ``["*"]``
917
917
918
918
A list of systems or system/partitions combinations that this logging configuration is valid for.
919
-
For a detailed description of this property, you may refer `here <#environments.target_systems>`__.
919
+
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.
920
920
921
921
922
922
@@ -1393,7 +1393,7 @@ The options of an execution mode will be passed to ReFrame as if they were speci
1393
1393
:default: ``["*"]``
1394
1394
1395
1395
A list of systems *only* that this execution mode is valid for.
1396
-
For a detailed description of this property, you may refer `here <#environments.target_systems>`__.
1396
+
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.
1397
1397
1398
1398
1399
1399
General Configuration
@@ -1640,7 +1640,7 @@ General Configuration
1640
1640
:default: ``["*"]``
1641
1641
1642
1642
A list of systems or system/partitions combinations that these general options are valid for.
1643
-
For a detailed description of this property, you may refer `here <#environments.target_systems>`__.
1643
+
For a detailed description of this property, have a look at the :attr:`~environments.target_systems` definition for environments.
Copy file name to clipboardExpand all lines: docs/tutorial_advanced.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -725,7 +725,7 @@ First, we need to enable the container platform support in ReFrame's configurati
725
725
:end-before: # rfmdocend: containers
726
726
:emphasize-lines: 9-18
727
727
728
-
For each partition, users can define a list of container platforms supported using the :attr:`~config.systems.partitions.container_platforms` configuration parameter.
728
+
For each partition, users can define a list of all supported container platforms using the :attr:`~config.systems.partitions.container_platforms` configuration parameter.
729
729
In this case, we define the `Sarus <https://github.com/eth-cscs/sarus>`__ platform for which we set the :attr:`~config.systems.partitions.container_platforms.modules` parameter in order to instruct ReFrame to load the ``sarus`` module, whenever it needs to run with this container platform.
730
730
Similarly, we add an entry for the `Singularity <https://sylabs.io>`__ platform.
731
731
Optionally, users are allowed to set the ``default`` attribute to :obj:`True` in order to mark a specific container platform as the default of that partition (see below on how this information is being used).
Copy file name to clipboardExpand all lines: docs/whats_new_40.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ It also introduces a couple of new deprecations.
6
6
7
7
ReFrame 4.0 maintains backward compatibility as much as possible.
8
8
Existing 3.x configurations and 3.x tests are expected to run out-of-the-box, despite any warnings issued.
9
-
Framework's behavior with respect to performance logging has also changed, but configuration options are offered so that users can switch to the old behavior.
9
+
The framework's behavior with respect to performance logging has also changed, but configuration options are offered so that users can switch to the old behavior.
10
10
11
11
This page summarizes the key changes in ReFrame 4.0 and what users should pay attention to.
12
12
@@ -27,8 +27,8 @@ This can also be very useful if you maintain a ReFrame installation used by othe
27
27
To assist with system-wide installation the ``RFM_CONFIG_PATH`` environment variable is introduced that allows you to specify a path where ReFrame will look for configuration files to load.
28
28
29
29
Now that systems and environments definitions can be distributed over multiple configuration files, it can become easy to accidentally redefine a system or environment without a notice.
30
-
For this reason, ReFrame warns you if a system or an environment are redefined in the same scope.
31
-
Since in the past all configuration files where extended copies of the builtin, you will get warnings that the ``generic`` system and the ``builtin`` environment are redefined, as ReFrame finds them in the builtin configuration, which is always loaded.
30
+
For this reason, ReFrame warns you if a system or an environment is redefined in the same scope.
31
+
Since in the past all configuration files where extended copies of the builtin configuration, you will get warnings that the ``generic`` system and the ``builtin`` environment are redefined, as ReFrame finds them in the builtin configuration, which is always loaded.
32
32
You can safely ignore these warnings and use the definitions in your configuration file.
33
33
If you want to eliminate them, though, you should remove the conflicting definitions from your configuration file.
0 commit comments