diff options
| author | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-05-28 16:47:13 +0900 |
|---|---|---|
| committer | bst-marge-bot <marge-bot@buildstream.build> | 2020-05-29 16:43:52 +0000 |
| commit | 30d8cb606d9adb84d9377b981f69f779bc85182a (patch) | |
| tree | 7d8c7ec1d9d4dfb0bef8f8aab639aa70e4f585b1 | |
| parent | e3de12e7a7c3e85278f484cec009f6d6f1b6e7d5 (diff) | |
| download | buildstream-30d8cb606d9adb84d9377b981f69f779bc85182a.tar.gz | |
doc/source/using_config.rst: Document support for version specific config files.
| -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 ---------------------- |