andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Fix warnings about unknown options

Browse Source
This commit is contained in:
Stein Magnus Jodal 2016-08-07 08:51:20 +02:00
parent 4ec06ef8f9
commit 12e0c87c99
1 changed files with 28 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
docs/changelog.rst
View File

@ -2091,10 +2091,10 @@ A release with a number of small and medium fixes, with no specific focus.
- Converted from the optparse to the argparse library for handling command line - Converted from the optparse to the argparse library for handling command line
options. options.
- :option:`mopidy --show-config` will now take into consideration any - ``mopidy --show-config`` will now take into consideration any
:option:`mopidy --option` arguments appearing later on the command line. This :option:`mopidy --option` arguments appearing later on the command line. This
helps you see the effective configuration for runs with the same helps you see the effective configuration for runs with the same
:option:`mopidy --options` arguments. ``mopidy --options`` arguments.
**Audio** **Audio**
@ -2168,7 +2168,7 @@ v0.14.1 (2013-04-28)
==================== ====================
This release addresses an issue in v0.14.0 where the new This release addresses an issue in v0.14.0 where the new
:option:`mopidy-convert-config` tool and the new :option:`mopidy --option` ``mopidy-convert-config`` tool and the new :option:`mopidy --option`
command line option was broken because some string operations inadvertently command line option was broken because some string operations inadvertently
converted some byte strings to unicode. converted some byte strings to unicode.
@ -2198,7 +2198,7 @@ one new.
As part of this change we have cleaned up the naming of our config values. As part of this change we have cleaned up the naming of our config values.
To ease migration we've made a tool named :option:`mopidy-convert-config` for To ease migration we've made a tool named ``mopidy-convert-config`` for
automatically converting the old ``settings.py`` to a new ``mopidy.conf`` automatically converting the old ``settings.py`` to a new ``mopidy.conf``
file. This tool takes care of all the renamed config values as well. See file. This tool takes care of all the renamed config values as well. See
``mopidy-convert-config`` for details on how to use it. ``mopidy-convert-config`` for details on how to use it.
@ -2231,11 +2231,11 @@ one new.
**Command line options** **Command line options**
- The command option :option:`mopidy --list-settings` is now named - The command option ``mopidy --list-settings`` is now named
:option:`mopidy --show-config`. ``mopidy --show-config``.
- The command option :option:`mopidy --list-deps` is now named - The command option ``mopidy --list-deps`` is now named
:option:`mopidy --show-deps`. ``mopidy --show-deps``.
- What configuration files to use can now be specified through the command - What configuration files to use can now be specified through the command
option :option:`mopidy --config`, multiple files can be specified using colon option :option:`mopidy --config`, multiple files can be specified using colon
@ -2245,8 +2245,8 @@ one new.
:option:`mopidy --option`. For example: ``mopidy --option :option:`mopidy --option`. For example: ``mopidy --option
spotify/enabled=false``. spotify/enabled=false``.
- The GStreamer command line options, :option:`mopidy --gst-*` and - The GStreamer command line options, ``mopidy --gst-*`` and
:option:`mopidy --help-gst` are no longer supported. To set GStreamer debug ``mopidy --help-gst`` are no longer supported. To set GStreamer debug
flags, you can use environment variables such as :envvar:`GST_DEBUG`. Refer flags, you can use environment variables such as :envvar:`GST_DEBUG`. Refer
to GStreamer's documentation for details. to GStreamer's documentation for details.
@ -2295,7 +2295,7 @@ already have.
**Core** **Core**
- Removed the :attr:`mopidy.settings.DEBUG_THREAD` setting and the - Removed the :attr:`mopidy.settings.DEBUG_THREAD` setting and the
:option:`--debug-thread` command line option. Sending SIGUSR1 to ``mopidy --debug-thread`` command line option. Sending SIGUSR1 to
the Mopidy process will now always make it log tracebacks for all alive the Mopidy process will now always make it log tracebacks for all alive
threads. threads.
@ -2576,9 +2576,8 @@ We've added an HTTP frontend for those wanting to build web clients for Mopidy!
- Make ``mopidy-scan`` ignore invalid dates, e.g. dates in years outside the - Make ``mopidy-scan`` ignore invalid dates, e.g. dates in years outside the
range 1-9999. range 1-9999.
- Make ``mopidy-scan`` accept :option:`-q`/:option:`--quiet` and - Make ``mopidy-scan`` accept ``-q``/``--quiet`` and ``-v``/``--verbose``
:option:`-v`/:option:`--verbose` options to control the amount of logging options to control the amount of logging output when scanning.
output when scanning.
- The scanner can now handle files with other encodings than UTF-8. Rebuild - The scanner can now handle files with other encodings than UTF-8. Rebuild
your tag cache with ``mopidy-scan`` to include tracks that may have been your tag cache with ``mopidy-scan`` to include tracks that may have been
@ -2703,7 +2702,7 @@ long time been our most requested feature. Finally, it's here!
**Developer support** **Developer support**
- Added optional background thread for debugging deadlocks. When the feature is - Added optional background thread for debugging deadlocks. When the feature is
enabled via the ``--debug-thread`` option or enabled via the ``mopidy --debug-thread`` option or
:attr:`mopidy.settings.DEBUG_THREAD` setting a ``SIGUSR1`` signal will dump :attr:`mopidy.settings.DEBUG_THREAD` setting a ``SIGUSR1`` signal will dump
the traceback for all running threads. the traceback for all running threads.
@ -2915,9 +2914,9 @@ resolved a bunch of related issues.
known setting, and suggests to the user what we think the setting should have known setting, and suggests to the user what we think the setting should have
been. been.
- Added :option:`--list-deps` option to the ``mopidy`` command that lists - Added ``mopidy --list-deps`` option that lists required and optional
required and optional dependencies, their current versions, and some other dependencies, their current versions, and some other information useful for
information useful for debugging. (Fixes: :issue:`74`) debugging. (Fixes: :issue:`74`)
- Added ``tools/debug-proxy.py`` to tee client requests to two backends and - Added ``tools/debug-proxy.py`` to tee client requests to two backends and
diff responses. Intended as a developer tool for checking for MPD protocol diff responses. Intended as a developer tool for checking for MPD protocol
@ -3197,12 +3196,12 @@ Please note that 0.5.0 requires some updated dependencies, as listed under
- Command line usage: - Command line usage:
- Support passing options to GStreamer. See :option:`--help-gst` for a list - Support passing options to GStreamer. See ``mopidy --help-gst`` for a list
of available options. (Fixes: :issue:`95`) of available options. (Fixes: :issue:`95`)
- Improve :option:`--list-settings` output. (Fixes: :issue:`91`) - Improve ``mopidy --list-settings`` output. (Fixes: :issue:`91`)
- Added :option:`--interactive` for reading missing local settings from - Added ``mopidy --interactive`` for reading missing local settings from
``stdin``. (Fixes: :issue:`96`) ``stdin``. (Fixes: :issue:`96`)
- Improve shutdown procedure at CTRL+C. Add signal handler for ``SIGTERM``, - Improve shutdown procedure at CTRL+C. Add signal handler for ``SIGTERM``,
@ -3345,8 +3344,8 @@ loading from Mopidy 0.3.0 is still present.
- Settings: - Settings:
- Fix crash on ``--list-settings`` on clean installation. Thanks to Martins - Fix crash on ``mopidy --list-settings`` on clean installation. Thanks to
Grunskis for the bug report and patch. (Fixes: :issue:`63`) Martins Grunskis for the bug report and patch. (Fixes: :issue:`63`)
- Packaging: - Packaging:
@ -3574,11 +3573,11 @@ to Valentin David.
- Simplify the default log format, - Simplify the default log format,
:attr:`mopidy.settings.CONSOLE_LOG_FORMAT`. From a user's point of view: :attr:`mopidy.settings.CONSOLE_LOG_FORMAT`. From a user's point of view:
Less noise, more information. Less noise, more information.
- Rename the :option:`--dump` command line option to - Rename the ``mopidy --dump`` command line option to
:option:`--save-debug-log`. :option:`mopidy --save-debug-log`.
- Rename setting :attr:`mopidy.settings.DUMP_LOG_FORMAT` to - Rename setting :attr:`mopidy.settings.DUMP_LOG_FORMAT` to
:attr:`mopidy.settings.DEBUG_LOG_FORMAT` and use it for :option:`--verbose` :attr:`mopidy.settings.DEBUG_LOG_FORMAT` and use it for
too. :option:`mopidy --verbose` too.
- Rename setting :attr:`mopidy.settings.DUMP_LOG_FILENAME` to - Rename setting :attr:`mopidy.settings.DUMP_LOG_FILENAME` to
:attr:`mopidy.settings.DEBUG_LOG_FILENAME`. :attr:`mopidy.settings.DEBUG_LOG_FILENAME`.
@ -3644,7 +3643,7 @@ fixing the OS X issues for a future release. You can track the progress at
- Exit early if not Python >= 2.6, < 3. - Exit early if not Python >= 2.6, < 3.
- Validate settings at startup and print useful error messages if the settings - Validate settings at startup and print useful error messages if the settings
has not been updated or anything is misspelled. has not been updated or anything is misspelled.
- Add command line option :option:`--list-settings` to print the currently - Add command line option ``mopidy --list-settings`` to print the currently
active settings. active settings.
- Include Sphinx scripts for building docs, pylintrc, tests and test data in - Include Sphinx scripts for building docs, pylintrc, tests and test data in
the packages created by ``setup.py`` for i.e. PyPI. the packages created by ``setup.py`` for i.e. PyPI.
@ -3826,7 +3825,7 @@ the established pace of at least a release per month.
- Improvements to MPD protocol handling, making Mopidy work much better with a - Improvements to MPD protocol handling, making Mopidy work much better with a
group of clients, including ncmpc, MPoD, and Theremin. group of clients, including ncmpc, MPoD, and Theremin.
- New command line flag :option:`--dump` for dumping debug log to ``dump.log`` - New command line flag ``mopidy --dump`` for dumping debug log to ``dump.log``
in the current directory. in the current directory.
- New setting :attr:`mopidy.settings.MIXER_ALSA_CONTROL` for forcing what ALSA - New setting :attr:`mopidy.settings.MIXER_ALSA_CONTROL` for forcing what ALSA
control :class:`mopidy.mixers.alsa.AlsaMixer` should use. control :class:`mopidy.mixers.alsa.AlsaMixer` should use.