mirror of
https://github.com/openSUSE/osc.git
synced 2025-02-22 02:02:11 +01:00
Document loading configuration from env variables
This commit is contained in:
parent
ce08022481
commit
b06ba4d895
@ -71,6 +71,11 @@ osc.conf._model_to_rst(
|
|||||||
description=textwrap.dedent(
|
description=textwrap.dedent(
|
||||||
"""
|
"""
|
||||||
The configuration file path is ``$XDG_CONFIG_HOME/osc/oscrc``, which usually translates into ``~/.config/osc/oscrc``.
|
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={
|
sections={
|
||||||
|
@ -1817,8 +1817,8 @@ def get_config(override_conffile=None,
|
|||||||
Configure osc.
|
Configure osc.
|
||||||
|
|
||||||
The configuration options are loaded with the following priority:
|
The configuration options are loaded with the following priority:
|
||||||
1. environment variables: OSC_<uppercase_option>
|
1. environment variables: ``OSC_<uppercase_option>`` or ``OSC_<uppercase_host_alias>_<uppercase_host_option>``
|
||||||
2. override arguments provided to get_config()
|
2. override arguments provided to ``get_config()``
|
||||||
3. oscrc config file
|
3. oscrc config file
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user