Skip to content

[doc] Improve documentation for the RFM_CONFIG_PATH #2743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 20, 2023
Merged

[doc] Improve documentation for the RFM_CONFIG_PATH #2743

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3afb979
Improve documention on the `RFM_CONFIG_PATH`
vkarak Jan 16, 2023
a1c2101
Fix typo in docs
vkarak Jan 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/manpage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,9 +765,9 @@ Miscellaneous options

This option can also be set using the :envvar:`RFM_CONFIG_FILES` environment variable.

In order to determine its final configuration, ReFrame first loads the builtin configuration file unconditionally and then starts looking for configuration files in the :envvar:`RFM_CONFIG_PATH`.
For each directory in the :envvar:`RFM_CONFIG_PATH`, ReFrame looks for files named ``setting.py`` or ``setting.json`` and loads them.
If both a ``settings.py`` and a ``settings.json`` file are found, the Python configuration will be preferred.
In order to determine its final configuration, ReFrame first loads the builtin configuration file unconditionally and then starts looking for possible configuration file locations defined in the :envvar:`RFM_CONFIG_PATH` environment variable.
For each directory defined in the :envvar:`RFM_CONFIG_PATH`, ReFrame looks for a file named ``settings.py`` or ``settings.json`` inside it and loads it.
If both a ``settings.py`` and a ``settings.json`` files are found, the Python configuration will be preferred.
ReFrame, finally, processes any configuration files specified in the command line or in the :envvar:`RFM_CONFIG_FILES` environment variable.

.. versionchanged:: 4.0.0
Expand Down