From fb07d400f27225e1acdb6f1de2c72c6abc52daa9 Mon Sep 17 00:00:00 2001 From: Rafael Sarmiento Date: Thu, 4 Oct 2018 10:07:56 +0200 Subject: [PATCH 1/2] update documentation of checks listing --- docs/running.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/running.rst b/docs/running.rst index c9a20c57ba..fc0fe95f21 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -98,8 +98,7 @@ The output looks like: The listing contains the name of the check, its description, the tags associated with it and a list of its maintainers. -Note that this listing may also contain checks that are not supported by the current system. -These checks will be just skipped if you try to run them. +Note that this listing only contains checks that are supported by the current system. Execution of the regression tests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -212,7 +211,8 @@ Filtering of Regression Tests ----------------------------- At this phase you can select which regression tests should be run or listed. -There are several ways to select regression tests, which we describe in more detail here: +All selections are preceded by a filtering over the tests that are supported by the +current system. There are several ways to select regression tests, which we describe in more detail here: Selecting tests by programming environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -226,7 +226,7 @@ To select tests by the programming environment, use the ``-p`` or ``--prgenv`` o This will select all the checks that support the ``PrgEnv-gnu`` environment. You can also specify multiple times the ``-p`` option, in which case a test will be selected if it support all the programming environments specified in the command line. -For example the following will select all the checks that can run with both ``PrgEnv-cray`` and ``PrgEnv-gnu``: +For example the following will select all the checks supported by the current system that can run with both ``PrgEnv-cray`` and ``PrgEnv-gnu``: .. code-block:: bash @@ -238,7 +238,7 @@ Selecting tests by tags ^^^^^^^^^^^^^^^^^^^^^^^ As we have seen in the `"ReFrame tutorial" `__, every regression test may be associated with a set of tags. Using the ``-t`` or ``--tag`` option you can select the regression tests associated with a specific tag. -For example the following will list all the tests that have a ``maintenance`` tag: +For example the following will list all the tests supported by the current system that have a ``maintenance`` tag: .. code-block:: bash From 6f52bed67329ed30a94140e622ef7aa4783e68d8 Mon Sep 17 00:00:00 2001 From: Vasileios Karakasis Date: Fri, 5 Oct 2018 10:28:59 +0200 Subject: [PATCH 2/2] Enhance docs on the selection of tests by system --- docs/running.rst | 49 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 42 insertions(+), 7 deletions(-) diff --git a/docs/running.rst b/docs/running.rst index fc0fe95f21..9850309bfe 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -43,7 +43,7 @@ The output looks like: .. code-block:: none Command line: ./bin/reframe -c tutorial/ -l - Reframe version: 2.13-dev0 + Reframe version: 2.15-dev0 Launched by user: USER Launched on host: daint103 Reframe paths @@ -97,8 +97,14 @@ The output looks like: Found 13 check(s). -The listing contains the name of the check, its description, the tags associated with it and a list of its maintainers. -Note that this listing only contains checks that are supported by the current system. +By default, this listing shows all the tests supported by the current system and contains the name of the check, its description, the tags associated with it and a list of its maintainers. + +.. note:: + .. versionchanged:: 2.15 + + Test listing lists only tests supported by the current system. + Previous versions were showing all the found tests. + Execution of the regression tests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -211,8 +217,37 @@ Filtering of Regression Tests ----------------------------- At this phase you can select which regression tests should be run or listed. -All selections are preceded by a filtering over the tests that are supported by the -current system. There are several ways to select regression tests, which we describe in more detail here: +There are several ways to select regression tests, which we describe in more detail here: + +Selecting tests by system +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 2.15 + + +By default, ReFrame always selects the tests that are supported by the current system. +If you want to list the tests supported by a different system, you may achieve that by passing the ``--system`` option: + +.. code-block:: bash + + ./bin/reframe --system=kesch -l + + +This example lists all the tests that are supported by the system named ``kesch``. +It is also possible to list only the tests that are supported by a specific system partition. +The following example will list only the tests suported by the ``login`` partition of the ``kesch`` system: + +.. code-block:: bash + + ./bin/reframe --system=kesch:login -l + + +Finally, in order to list all the tests found regardless of their supported systems, you should pass the ``--skip-system-check`` option: + +.. code-block:: bash + + ./bin/reframe --skip-system-check -l + Selecting tests by programming environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -226,7 +261,7 @@ To select tests by the programming environment, use the ``-p`` or ``--prgenv`` o This will select all the checks that support the ``PrgEnv-gnu`` environment. You can also specify multiple times the ``-p`` option, in which case a test will be selected if it support all the programming environments specified in the command line. -For example the following will select all the checks supported by the current system that can run with both ``PrgEnv-cray`` and ``PrgEnv-gnu``: +For example the following will select all the checks that can run with both ``PrgEnv-cray`` and ``PrgEnv-gnu`` on the current system: .. code-block:: bash @@ -238,7 +273,7 @@ Selecting tests by tags ^^^^^^^^^^^^^^^^^^^^^^^ As we have seen in the `"ReFrame tutorial" `__, every regression test may be associated with a set of tags. Using the ``-t`` or ``--tag`` option you can select the regression tests associated with a specific tag. -For example the following will list all the tests supported by the current system that have a ``maintenance`` tag: +For example the following will list all the tests that have a ``maintenance`` tag and can run on the current system: .. code-block:: bash