diff options
| author | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-05-28 16:47:13 +0900 |
|---|---|---|
| committer | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-05-28 17:49:41 +0900 |
| commit | 0cc1dbc7778370058f235dc02335ca26cfb65f16 (patch) | |
| tree | 1a14ba6d583cc3ac387c3ff021df462bfc810bc0 | |
| parent | 1d2dc78a16aaab306598cfdc62ab0f24c3dc704e (diff) | |
| download | buildstream-tristan/version-specific-config.tar.gz | |
doc/source/using_config.rst: Document support for version specific config files.tristan/version-specific-config
| -rw-r--r-- | doc/source/using_config.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/using_config.rst b/doc/source/using_config.rst index 302abb2f1..ba38173e3 100644 --- a/doc/source/using_config.rst +++ b/doc/source/using_config.rst @@ -22,6 +22,17 @@ invoking ``bst``, an attempt is made to load user specific configuration from ``$XDG_CONFIG_HOME/buildstream.conf``. On most Linux based systems, the location will be ``~/.config/buildstream.conf`` +.. note:: + + If you have have multiple major versions of BuildStream installed, you + can have separate configuration files in your ``${XDG_CONFIG_HOME}``. + + You can do this by naming them according to the major versions of + BuildStream you have installed. BuildStream 1 will load it's configuration + from ``$XDG_CONFIG_HOME/buildstream1.conf`` and BuildStream 2 will load + it's configuration from ``$XDG_CONFIG_HOME/buildstream2.conf``, while + any version will fallback to ``$XDG_CONFIG_HOME/buildstream.conf``. + Project specific value ---------------------- |