1
0
mirror of https://github.com/openSUSE/osc.git synced 2024-11-08 22:06:16 +01:00

Document loading configuration from env variables

This commit is contained in:
Daniel Mach 2024-05-07 16:34:59 +02:00
parent cc9f23faa0
commit b43c77dfb7
2 changed files with 7 additions and 2 deletions

View File

@ -71,6 +71,11 @@ osc.conf._model_to_rst(
description=textwrap.dedent(
"""
The configuration file path is ``$XDG_CONFIG_HOME/osc/oscrc``, which usually translates into ``~/.config/osc/oscrc``.
The configuration options are loaded with the following priority:
1. environment variables: ``OSC_<uppercase_option>`` or ``OSC_<uppercase_host_alias>_<uppercase_host_option>``
2. command-line options
3. oscrc config file
"""
),
sections={

View File

@ -1817,8 +1817,8 @@ def get_config(override_conffile=None,
Configure osc.
The configuration options are loaded with the following priority:
1. environment variables: OSC_<uppercase_option>
2. override arguments provided to get_config()
1. environment variables: ``OSC_<uppercase_option>`` or ``OSC_<uppercase_host_alias>_<uppercase_host_option>``
2. override arguments provided to ``get_config()``
3. oscrc config file
"""