diff options
| author | Ben Nemec <bnemec@redhat.com> | 2019-04-03 22:23:48 +0000 |
|---|---|---|
| committer | Ben Nemec <bnemec@redhat.com> | 2019-04-03 22:23:48 +0000 |
| commit | fce7228c717943a7cf8d2daaaf14dec84ea1accd (patch) | |
| tree | b7e44ae26feaa89a1032f78c6244f4b03f7aef9a | |
| parent | 6c951ed373f443727a8ea2d10d346ad769285aa2 (diff) | |
| download | oslo-config-fce7228c717943a7cf8d2daaaf14dec84ea1accd.tar.gz | |
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
| -rw-r--r-- | oslo_config/cfg.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/oslo_config/cfg.py b/oslo_config/cfg.py index f8c0eb3..ca3ae56 100644 --- a/oslo_config/cfg.py +++ b/oslo_config/cfg.py @@ -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 |