Skip to content

Commit 3325b59

Browse files
committed
Make clear that no ALL YAML files in config dir are read
1 parent f7a3bb3 commit 3325b59

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

doc/quickstart/configure.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ options can be specified via YAML files and command line arguments.
3636
YAML files
3737
----------
3838

39-
:ref:`Configuration options <config_options>` can be specified via YAML files.
39+
:ref:`Configuration options <config_options>` can be specified via YAML files
40+
(i.e., ``*.yaml`` and ``*.yml``).
4041

4142
A file could look like this (for example, located at
4243
``~/.config/esmvaltool/config.yml``):
@@ -64,6 +65,13 @@ via command line argument is preferred over the user configuration directory).
6465
Within a directory, files are sorted alphabetically, and later files (e.g.,
6566
``z.yml``) will take precedence over earlier files (e.g., ``a.yml``).
6667

68+
.. warning::
69+
70+
ESMValCore will read **all** YAML files in these configuration directories.
71+
Thus, other YAML files in this directory which are not valid configuration
72+
files (like the old ``config-developer.yml`` files) will lead to errors.
73+
Make sure to move these files to a different directory.
74+
6775
To get a copy of the default configuration file, you can run
6876

6977
.. code-block:: bash

0 commit comments

Comments
 (0)