Document loading configuration from env variables

openSUSE · May 7, 2024 · b43c77d · b43c77d
1 parent cc9f23f
commit b43c77d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -71,6 +71,11 @@
     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={

diff --git a/osc/conf.py b/osc/conf.py
@@ -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
     """