tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'clarify-config-paths' into develop

This commit is contained in:
Foo 2015-05-30 14:24:47 +03:00
parent 71386c11c3 acb098a382
commit 44d843aaed
1 changed files with 20 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/source/configuration.rst
View File

@ -15,20 +15,27 @@ written in Python.
Powerline provides default configurations in the following locations: Powerline provides default configurations in the following locations:
:ref:`Main configuration <config-main>` :ref:`Main configuration <config-main>`
:file:`powerline/config.json` :file:`{powerline}/config.json`
:ref:`Colorschemes <config-colorschemes>` :ref:`Colorschemes <config-colorschemes>`
:file:`powerline/colorschemes/{name}.json`, :file:`{powerline}/colorschemes/{name}.json`,
:file:`powerline/colorscheme/{extension}/__main__.json`, :file:`{powerline}/colorschemes/{extension}/__main__.json`,
:file:`powerline/colorschemes/{extension}/{name}.json` :file:`{powerline}/colorschemes/{extension}/{name}.json`
:ref:`Themes <config-themes>` :ref:`Themes <config-themes>`
:file:`powerline/themes/{top_theme}.json`, :file:`{powerline}/themes/{top_theme}.json`,
:file:`powerline/themes/{extension}/__main__.json`, :file:`{powerline}/themes/{extension}/__main__.json`,
:file:`powerline/themes/{extension}/default.json` :file:`{powerline}/themes/{extension}/default.json`
The default configuration files are stored in the main package. User Here `{powerline}` is one of the following:
configuration files are stored in :file:`$XDG_CONFIG_HOME/powerline` for
Linux users, and in :file:`~/.config/powerline` for OS X users. This usually #. The default configuration directory located in the main package:
corresponds to :file:`~/.config/powerline` on both platforms. :file:`{powerline_root}/powerline/config_files`. May be absent in some
packages (e.g. when installing via Gentoo ebuilds).
#. If variable ``$XDG_CONFIG_DIRS`` is set and non-empty then to any
:file:`{directory}/powerline` where `{directory}` is a directory listed in
a colon-separated ``$XDG_CONFIG_DIRS`` list. Directories are checked in
reverse order.
#. User configuration directory located in :file:`$XDG_CONFIG_HOME/powerline`.
This usually corresponds to :file:`~/.config/powerline` on all platforms.
If per-instance configuration is needed please refer to :ref:`Local If per-instance configuration is needed please refer to :ref:`Local
configuration overrides <local-configuration-overrides>`. configuration overrides <local-configuration-overrides>`.
@ -37,17 +44,8 @@ configuration overrides <local-configuration-overrides>`.
.. note:: .. note::
Existing multiple configuration files that have the same name, but are placed Existing multiple configuration files that have the same name, but are placed
in different directories, will be merged. Merging happens in the following in different directories, will be merged. Merging happens in the order given
order: in the above list of possible `{powerline}` meanings.
* :file:`{powerline_root}/powerline/config_files` is checked for
configuration first. Configuration from this source has least priority.
* :file:`$XDG_CONFIG_DIRS/powerline` directories are the next ones to check.
Checking happens in the reversed order: directories mentioned last are
checked before directories mentioned first. Each new found file is merged
with the result of previous merge.
* :file:`$XDG_CONFIG_HOME/powerline` directory is the last to check.
Configuration from there has top priority.
When merging configuration only dictionaries are merged and they are merged When merging configuration only dictionaries are merged and they are merged
recursively: keys from next file overrule those from the previous unless recursively: keys from next file overrule those from the previous unless