Docs missing details on config-dir default behavior

[Ben Nemec]

The default value for config-dir is complicated and right now the only documentation of it lives in the docstring for the function: https://github.com/openstack/oslo.config/blob/0bc22839b09fcd7ae2de4f7fe5d63ac055fd0a78/oslo_config/cfg.py#L320

This is bad for two reasons: 1) that API isn't being included in the docs so one has to read the code to figure out how it works and 2) users shouldn't have to look at API docs to figure out how basic functionality like this works. We need something in the user docs that explain the config-dir default behavior.

[Ben Nemec (bnemec)]

It turns out this wasn't entirely true. config-dir is documented, but it was buried at the bottom of the doc index. Also, there was no documentation of how config-dir interacts with config-file, so there was still improvement to be made. I've pushed a couple of patches to improve that situation.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/654556
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=144e16d532be4edd6736b31a00d56322749ce89a
Submitter: Zuul
Branch: master

commit 144e16d532be4edd6736b31a00d56322749ce89a
Author: Ben Nemec <email address hidden>
Date: Mon Apr 22 16:13:29 2019 +0000

    Document precedence of config sources

    Previously the precedence details for the various sources oslo.config
    can consume were scattered around the developer documentation (for
    example in [0]). Since this is relevant for users too, we need to
    include it in the user-focused documentation.

    This collects all of the precedence information I am aware of and puts
    it on the documentation page for --config-file, --config-dir, and the
    sample source driver options.

    It also clarifies the file and dir precedence in the developer docs since
    previously that was only available in the API docstring.

    Change-Id: I41d8ac0f33ea60aea8ba5b150e53d7eafa323457
    0: https://github.com/openstack/oslo.config/blob/0bc22839b09fcd7ae2de4f7fe5d63ac055fd0a78/oslo_config/cfg.py#L2095
    Closes-Bug: 1825859

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/oslo.config 6.10.0 release.