docs: Elaborate on core/{cache,data}_dir usage

Related to #1253
This commit is contained in:
Stein Magnus Jodal 2015-08-21 19:57:39 +02:00
parent 7411c84ba7
commit 77e8436f3e
2 changed files with 16 additions and 0 deletions

View File

@ -65,6 +65,13 @@ Core configuration
Path to base directory for storing cached data.
Mopidy and extensions will use this path to cache data that can safely be
thrown away.
If your system is running from an SD card, it can help avoid wear and
corruption of your SD card by pointing this config to another location. If
you have enough RAM, a tmpfs might be a good choice.
When running Mopidy as a regular user, this should usually be
``$XDG_CACHE_DIR/mopidy``, i.e. :file:`~/.cache/mopidy`.
@ -85,6 +92,11 @@ Core configuration
Path to base directory for persistent data files.
Mopidy and extensions will use this path to store data that cannot be
be thrown away and reproduced without some effort. Examples include
Mopidy-Local's index of your media library and Mopidy-M3U's stored
playlists.
When running Mopidy as a regular user, this should usually be
``$XDG_DATA_DIR/mopidy``, i.e. :file:`~/.local/share/mopidy`.

View File

@ -63,6 +63,8 @@ class Extension(object):
def get_cache_dir(self, config):
"""Get or create cache directory for the extension.
Use this directory to cache data that can safely be thrown away.
:param config: the Mopidy config object
:return: string
"""
@ -87,6 +89,8 @@ class Extension(object):
def get_data_dir(self, config):
"""Get or create data directory for the extension.
Use this directory to store data that should be persistent.
:param config: the Mopidy config object
:returns: string
"""