Clarify help on config-file and config-dir options

These options are intended to be set from the command-line, as they
are used to find the config files we will parse. There's a
chicken-and-egg problem with setting them from those config files,
but since these appear in service sample configs it may not be
immediately obvious to users.

Change-Id: I7afc9ce979cebe5427a19cbf33c412ab9b23d3ae
This commit is contained in:
Ben Nemec 2019-04-03 22:23:48 +00:00
parent 6c951ed373
commit fce7228c71
1 changed files with 4 additions and 2 deletions

View File

@ -2003,7 +2003,8 @@ class ConfigOpts(Mapping):
help=('Path to a config file to use. Multiple '
'config files can be specified, with values '
'in later files taking precedence. Defaults '
'to %(default)s.')),
'to %(default)s. This option must be set '
'from the command-line.')),
_ConfigDirOpt('config-dir',
metavar='DIR',
default=default_config_dirs,
@ -2014,7 +2015,8 @@ class ConfigOpts(Mapping):
'is parsed after the file(s) specified via '
'previous --config-file, arguments hence '
'over-ridden options in the directory take '
'precedence.'),
'precedence. This option must be set from '
'the command-line.'),
]
@classmethod