Skip to content

Commit 51c85d9

Browse files
Correct system and partition name
Deals with #3198. Also corrects a mischaracterization of `builtin`; it is not a partition, it is an environment.
1 parent dd890cc commit 51c85d9

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/tutorial.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ Here is an example for our STREAM benchmark:
270270
}
271271
}
272272
273-
The :attr:`reference` test variable is a multi-level dictionary that defines the expected performance for each of the test's performance variables on all supported systems.
273+
The :attr:`reference` test variable is a multi-level dictionary that defines the expected performance for each of the test's performance variables on all supported systems (here, ``generic``) and partitions (here, ``default``). We explain more about this pre-defined system later in :ref:`systems-and-environments`.
274274
It is not necessary that all performance variables and all systems have a reference.
275275
If a reference value is not found, then the obtained performance will be logged, but no performance validation will be performed.
276276
The reference value is essentially a three or four element tuple of the form: ``(target_perf, lower_thres, upper_thres, unit)``. The ``unit`` is optional as it is already defined in the :func:`@performance_function <reframe.core.builtins.performance_function>` definitions.
@@ -310,6 +310,8 @@ Note that the ``RUN`` message is replaced by ``DRY`` in the dry-run mode.
310310
You can also check the generated test script in ``stage/generic/default/builtin/stream_test/rfm_job.sh``.
311311

312312

313+
.. _systems-and-environments:
314+
313315
Systems and environments
314316
========================
315317

@@ -338,7 +340,7 @@ We could do that simply by setting the :attr:`valid_prog_environs` as follows:
338340
339341
self.valid_prog_environs = ['+stream']
340342
341-
This tells ReFrame that this test is valid only for environments that define the ``stream`` feature.
343+
This tells ReFrame that this test is valid only for environments that define the ``stream`` feature; the ``+`` prefix requests a feature. The syntax defined in :attr:`valid_prog_environs` allows for other requirements.
342344
If we try to run the test now, nothing will be run:
343345

344346
.. code-block:: bash
@@ -355,7 +357,7 @@ If we try to run the test now, nothing will be run:
355357
This happens because ReFrame by default defines a generic system and environment.
356358
You may have noticed in our first run the ``@generic:default+builtin`` notation printed after test name.
357359
This is the system partition name (``generic:default``) and the environment name (``builtin``) where the test is being run in.
358-
The ``generic`` system and the ``builtin`` partition come as predefined in ReFrame.
360+
The ``generic`` system and the ``builtin`` environment come as predefined in ReFrame.
359361
They make the minimum possible assumptions:
360362

361363
- The ``generic`` system defines a single partition, named ``default`` which launches test jobs locally.

0 commit comments

Comments
 (0)