From 299f1c906ea89e75bda8be5e897047b8ca519246 Mon Sep 17 00:00:00 2001 From: jtagcat Date: Wed, 13 Jul 2022 10:07:59 +0000 Subject: [PATCH] docs: overview: clarify configs _are_ ordered 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 --- docs/configuration/overview.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/configuration/overview.rst b/docs/configuration/overview.rst index 98ac15b..d4d07ae 100644 --- a/docs/configuration/overview.rst +++ b/docs/configuration/overview.rst @@ -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. -The following paths are considered: +The following paths are searched, in this order: -* If set, the location specified via the global ``--config`` flag -* ``/etc/zrepl/zrepl.yml`` -* ``/usr/local/etc/zrepl/zrepl.yml`` +1. If set, the location specified via the global ``--config`` flag +2. ``/etc/zrepl/zrepl.yml`` +3. ``/usr/local/etc/zrepl/zrepl.yml`` 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.