extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-24 17:35:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: overview: clarify configs _are_ ordered

Browse Source 
Previously with unordered list, and 'are considered'
left if unsure whether one or all files are 'considered'.
In reality, the first valid is used, so an ordered list and
perhaps better wording communicates this fact.

refs https://github.com/zrepl/zrepl/pull/618
This commit is contained in:
jtagcat 2022-07-13 10:07:59 +00:00 committed by Christian Schwarz
parent d3f68ae4e8
commit 299f1c906e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/configuration/overview.rst
View File

@ -3,11 +3,11 @@ Overview & Terminology
====================== ======================
All work zrepl does is performed by the zrepl daemon which is configured in a single YAML configuration file loaded on startup. All work zrepl does is performed by the zrepl daemon which is configured in a single YAML configuration file loaded on startup.
The following paths are considered: The following paths are searched, in this order:
* If set, the location specified via the global ``--config`` flag 1. If set, the location specified via the global ``--config`` flag
* ``/etc/zrepl/zrepl.yml`` 2. ``/etc/zrepl/zrepl.yml``
* ``/usr/local/etc/zrepl/zrepl.yml`` 3. ``/usr/local/etc/zrepl/zrepl.yml``
The ``zrepl configcheck`` subcommand can be used to validate the configuration. The ``zrepl configcheck`` subcommand can be used to validate the configuration.
The command will output nothing and exit with zero status code if the configuration is valid. The command will output nothing and exit with zero status code if the configuration is valid.