Skip to content

Commit 5fa59e1

Browse files
authored
Merge pull request #3213 from vkarak/doc/update-conf-manpage
[doc] Update description of the configuration in the manpage
2 parents de93b62 + 5bae28a commit 5fa59e1

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

docs/manpage.rst

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1473,6 +1473,13 @@ Whenever an environment variable is associated with a configuration option, its
14731473
================================== ==================
14741474

14751475

1476+
.. envvar:: RFM_INSTALL_PREFIX
1477+
1478+
The framework's installation prefix.
1479+
Users cannot set this variable.
1480+
ReFrame will set it always upon startup.
1481+
1482+
14761483
.. envvar:: RFM_KEEP_STAGE_FILES
14771484

14781485
Keep test stage directories even for tests that finish successfully.
@@ -1825,28 +1832,15 @@ Whenever an environment variable is associated with a configuration option, its
18251832
Configuration File
18261833
------------------
18271834

1828-
The configuration file of ReFrame defines the systems and environments to test as well as parameters controlling its behavior.
1829-
Upon start up ReFrame checks for configuration files in the following locations in that order:
1830-
1831-
1. ``$HOME/.reframe/settings.{py,json}``
1832-
2. ``$RFM_INSTALL_PREFIX/settings.{py,json}``
1833-
3. ``/etc/reframe.d/settings.{py,json}``
1834-
1835-
ReFrame accepts configuration files either in Python or JSON syntax.
1836-
If both are found in the same location, the Python file will be preferred.
1837-
1838-
The ``RFM_INSTALL_PREFIX`` environment variable refers to the installation directory of ReFrame.
1839-
Users have no control over this variable.
1840-
It is always set by the framework upon startup.
1835+
The configuration file of ReFrame defines the systems and environments to test as well as parameters controlling the framework's behavior.
18411836

1842-
If no configuration file can be found in any of the predefined locations, ReFrame will fall back to a generic configuration that allows it to run on any system.
1843-
This configuration file is located in |reframe/core/settings.py|_.
1844-
Users may *not* modify this file.
1837+
ReFrame loads multiple configuration files to determine its final configuration.
1838+
First, it loads unconditionally its builtin configuration which is located in ``${RFM_INSTALL_PREFIX}/reframe/core/settings.py``.
1839+
If the :envvar:`RFM_CONFIG_PATH` environment variable is defined, ReFrame will look for configuration files named either ``settings.py`` or ``settings.json`` (in that order) in every location in the path and will load them.
1840+
Finally, the :option:`--config-file` option is processed and any configuration files specified will also be loaded.
18451841

1846-
For a complete reference of the configuration, please refer to :doc:`reframe.settings(8) <config_reference>` man page.
1842+
For a complete reference of the available configuration options, please refer to the :doc:`reframe.settings(8) <config_reference>` man page.
18471843

1848-
.. |reframe/core/settings.py| replace:: ``reframe/core/settings.py``
1849-
.. _reframe/core/settings.py: https://github.com/reframe-hpc/reframe/blob/master/reframe/core/settings.py
18501844

18511845
Reporting Bugs
18521846
--------------

0 commit comments

Comments
 (0)