Skip to content

Commit cc5e23e

Browse files
committed
Address PR comments (2)
1 parent 6c306b6 commit cc5e23e

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/config_reference.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The full schema describing it can be found in |schemas/config.json|_ file.
1111
The final configuration for ReFrame is validated against this schema.
1212

1313
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.
1515
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.
1616
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.
1717
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
2525
-----------------------
2626

2727
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*:
2929

3030
.. py:data:: systems
3131
@@ -671,7 +671,7 @@ ReFrame allows you to define custom scheduler resources for each partition that
671671
]
672672
673673
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:
675675

676676
.. code:: python
677677
@@ -916,7 +916,7 @@ You may define different logger objects per system but *not* per partition.
916916
:default: ``["*"]``
917917

918918
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.
920920

921921

922922

@@ -1393,7 +1393,7 @@ The options of an execution mode will be passed to ReFrame as if they were speci
13931393
:default: ``["*"]``
13941394

13951395
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.
13971397

13981398

13991399
General Configuration
@@ -1640,7 +1640,7 @@ General Configuration
16401640
:default: ``["*"]``
16411641

16421642
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.
16441644

16451645

16461646
.. py:attribute:: general.timestamp_dirs

docs/tutorial_advanced.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ First, we need to enable the container platform support in ReFrame's configurati
725725
:end-before: # rfmdocend: containers
726726
:emphasize-lines: 9-18
727727

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.
729729
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.
730730
Similarly, we add an entry for the `Singularity <https://sylabs.io>`__ platform.
731731
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).

docs/whats_new_40.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It also introduces a couple of new deprecations.
66

77
ReFrame 4.0 maintains backward compatibility as much as possible.
88
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.
1010

1111
This page summarizes the key changes in ReFrame 4.0 and what users should pay attention to.
1212

@@ -27,8 +27,8 @@ This can also be very useful if you maintain a ReFrame installation used by othe
2727
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.
2828

2929
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.
3232
You can safely ignore these warnings and use the definitions in your configuration file.
3333
If you want to eliminate them, though, you should remove the conflicting definitions from your configuration file.
3434

0 commit comments

Comments
 (0)