From bfb5c45ebe11f2322b34c17668b741c8f1ada992 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Fri, 21 Jan 2011 21:55:09 +0100 Subject: [PATCH] Cleanup changelog --- docs/changes.rst | 135 +++++++++++++++++++++++++--------------------- docs/settings.rst | 10 ++-- 2 files changed, 80 insertions(+), 65 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index e8d1a88f..f27a45c9 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -17,19 +17,23 @@ This change log is used to track all major changes to Mopidy. described at :issue:`59`. -No description yet. - - **Important changes** +- If you use the Spotify backend, you need to upgrade to libspotify 0.0.6 and + the latest pyspotify from the Mopidy developers. Follow the instructions at + :doc:`/installation/libspotify/`. + +- If you use the Last.fm frontend, you need to upgrade to pylast 0.5. Run + ``sudp pip install --upgrade pylast`` or install Mopidy from APT. + + +**Changes** + - Spotify backend: - - If you use the Spotify backend, you need to upgrade to libspotify 0.0.6 and - the latest pyspotify from the Mopidy developers. Follow the instructions at - :doc:`/installation/libspotify/`. - - - Support high bitrate (320k) audio. See - :attr:`mopidy.settings.SPOTIFY_HIGH_BITRATE` for details. + - Support high bitrate (320k) audio. Set the new setting + :attr:`mopidy.settings.SPOTIFY_HIGH_BITRATE` to :class:`True` to switch to + high bitrate audio. - Rename :mod:`mopidy.backends.libspotify` to :mod:`mopidy.backends.spotify`. If you have set :attr:`mopidy.settings.BACKENDS` explicitly, you may need @@ -37,88 +41,97 @@ No description yet. - Catch and log error caused by playlist folder boundaries being threated as normal playlists. More permanent fix requires support for checking playlist - types in pyspotify. + types in pyspotify (see :issue:`62`). + +- Local backend: + + - Add :command:`mopidy-scan` command to generate ``tag_cache`` files without + any help from the original MPD server. See :ref:`generating_a_tag_cache` + for instructions on how to use it. + + - Fix support for UTF-8 encoding in tag caches. + +- MPD frontend: + + - Add support for password authentication. See + :attr:`mopidy.settings.MPD_SERVER_PASSWORD` and + :ref:`use_mpd_on_a_network` for details on how to use it. (Fixes: + :issue:`41`) + + - Support ``setvol 50`` without quotes around the argument. Fixes volume + control in Droid MPD. + + - Support ``seek 1 120`` without quotes around the arguments. Fixes seek in + Droid MPD. - Last.fm frontend: - - If you use the Last.fm frontend, you need to upgrade to pylast 0.5. - - Update to use Last.fm's new Scrobbling 2.0 API, as the old Submissions Protocol 1.2.1 is deprecated. (Fixes: :issue:`33`) - Fix crash when track object does not contain all the expected meta data. +- Mixers: -**Changes** + - Support use of unicode strings for settings specific to + :mod:`mopidy.mixers.nad`. - Settings: - - Automatically expand ``~`` to the user's home directory and make the path - absolute for settings with names ending in ``_PATH`` or ``_FILE``. + - Automatically expand the "~" characted to the user's home directory and + make the path absolute for settings with names ending in ``_PATH`` or + ``_FILE``. + - Rename the following settings. The settings validator will warn you if you need to change your local settings. - - ``LOCAL_MUSIC_FOLDER`` to :attr:`mopidy.settings.LOCAL_MUSIC_PATH` - - ``LOCAL_PLAYLIST_FOLDER`` to - :attr:`mopidy.settings.LOCAL_PLAYLIST_PATH` - - ``LOCAL_TAG_CACHE`` to :attr:`mopidy.settings.LOCAL_TAG_CACHE_FILE` - - ``SPOTIFY_LIB_CACHE`` to :attr:`mopidy.settings.SPOTIFY_CACHE_PATH` + - ``LOCAL_MUSIC_FOLDER`` to :attr:`mopidy.settings.LOCAL_MUSIC_PATH` + - ``LOCAL_PLAYLIST_FOLDER`` to + :attr:`mopidy.settings.LOCAL_PLAYLIST_PATH` + - ``LOCAL_TAG_CACHE`` to :attr:`mopidy.settings.LOCAL_TAG_CACHE_FILE` + - ``SPOTIFY_LIB_CACHE`` to :attr:`mopidy.settings.SPOTIFY_CACHE_PATH` + + - Fix bug which made settings set to :class:`None` or 0 cause a + :exc:`mopidy.SettingsError` to be raised. - Packaging and distribution: + - Setup APT repository and crate Debian packages of Mopidy. See + :ref:`installation` for instructions for how to install Mopidy, including + all dependencies, from APT. + - Install ``mopidy.desktop`` file that makes Mopidy available from e.g. Gnome application menus. - - Create infrastructure for creating Debian packages of Mopidy. -- MPD frontend: - - - Add support for password authentication. See - :attr:`mopidy.settings.MPD_SERVER_PASSWORD` and - :ref:`use_mpd_on_a_network` for details on how to use it. - - Support ``setvol 50`` without quotes around the argument. Fixes volume - control in Droid MPD. - - Support ``seek 1 120`` without quotes around the arguments. Fixes seek in - Droid MPD. - -- Local backend: - - - Add :command:`mopidy-scan` command to generate ``tag_cache`` files without - any help from the original MPD server. - - Support UTF-8 encoded tag caches with non-ASCII characters. - -- Mixers: - - - Support use of unicode strings for :mod:`mopidy.mixers.nad` specific - settings. - -- Models: +- API: - Rename and generalize ``Playlist._with(**kwargs)`` to :meth:`mopidy.models.ImmutableObject.copy`. + - Add ``musicbrainz_id`` field to :class:`mopidy.models.Artist`, :class:`mopidy.models.Album`, and :class:`mopidy.models.Track`. -- Introduce the :ref:`provider concept `. Split the backend - API into a :ref:`backend controller API ` (for - frontend use) and a :ref:`backend provider API ` (for - backend implementation use), which includes the following changes: + - Prepare for multi-backend support (see :issue:`40`) by introducing the + :ref:`provider concept `. Split the backend API into a + :ref:`backend controller API ` (for frontend use) + and a :ref:`backend provider API ` (for backend + implementation use), which includes the following changes: - - Rename ``BaseBackend`` to :class:`mopidy.backends.base.Backend`. - - Rename ``BaseCurrentPlaylistController`` to - :class:`mopidy.backends.base.CurrentPlaylistController`. - - Split ``BaseLibraryController`` to - :class:`mopidy.backends.base.LibraryController` and - :class:`mopidy.backends.base.BaseLibraryProvider`. - - Split ``BasePlaybackController`` to - :class:`mopidy.backends.base.PlaybackController` and - :class:`mopidy.backends.base.BasePlaybackProvider`. - - Split ``BaseStoredPlaylistsController`` to - :class:`mopidy.backends.base.StoredPlaylistsController` and - :class:`mopidy.backends.base.BaseStoredPlaylistsProvider`. - -- Other API and package structure cleaning: + - Rename ``BaseBackend`` to :class:`mopidy.backends.base.Backend`. + - Rename ``BaseCurrentPlaylistController`` to + :class:`mopidy.backends.base.CurrentPlaylistController`. + - Split ``BaseLibraryController`` to + :class:`mopidy.backends.base.LibraryController` and + :class:`mopidy.backends.base.BaseLibraryProvider`. + - Split ``BasePlaybackController`` to + :class:`mopidy.backends.base.PlaybackController` and + :class:`mopidy.backends.base.BasePlaybackProvider`. + - Split ``BaseStoredPlaylistsController`` to + :class:`mopidy.backends.base.StoredPlaylistsController` and + :class:`mopidy.backends.base.BaseStoredPlaylistsProvider`. - Move ``BaseMixer`` to :class:`mopidy.mixers.base.BaseMixer`. + - Add docs for the current non-stable output API, :class:`mopidy.outputs.base.BaseOutput`. diff --git a/docs/settings.rst b/docs/settings.rst index 8ac83e92..1d4a4972 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -59,11 +59,13 @@ You may also want to change some of the ``LOCAL_*`` settings. See hopefully have support for this in the 0.3 release. +.. _generating_a_tag_cache: + Generating a tag cache ---------------------- -Previously the local storage backend relied purely on ``tag_cache`` files -generated by the original MPD server. To remedy this the command +Before Mopidy 0.3 the local storage backend relied purely on ``tag_cache`` +files generated by the original MPD server. To remedy this the command :command:`mopidy-scan` has been created. The program will scan your current :attr:`mopidy.settings.LOCAL_MUSIC_PATH` and build a MPD compatible ``tag_cache``. @@ -82,8 +84,8 @@ To make a ``tag_cache`` of your local music available for Mopidy: mopidy-scan > tag_cache #. Move the ``tag_cache`` file to the location - :attr:`mopidy.settings.LOCAL_TAG_CACHE_FILE` is set to, or change the setting to - point to where your ``tag_cache`` file is. + :attr:`mopidy.settings.LOCAL_TAG_CACHE_FILE` is set to, or change the + setting to point to where your ``tag_cache`` file is. #. Start Mopidy, find the music library in a client, and play some local music!