From 60c59ca96ae7f5a612d4f84e00a2fa7b79b1b2aa Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 10 Aug 2014 16:51:42 -0700 Subject: [PATCH] Docs/changelog for #891 --- docs/changelog.rst | 6 +++++- docs/plugins/convert.rst | 7 ++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 01307b6d8..a7d20d923 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,7 +12,8 @@ New stuff IFF chunks. * A new :ref:`required` configuration option for the importer skips matches that are missing certain data. Thanks to oprietop. -* The new :doc:`/plugins/bpm` lets you manually measure the tempo of a playing song. Thanks to aroquen. +* The new :doc:`/plugins/bpm` lets you manually measure the tempo of a playing + song. Thanks to aroquen. Little improvements and fixes: @@ -73,6 +74,9 @@ Little improvements and fixes: extensions (extensions default to the name of the preset). * A new :ref:`asciify-paths` configuration option replaces all non-ASCII characters in paths. +* :doc:`/plugins/convert`: A new ``--pretend`` option lets you preview the + commands the plugin will execute without actually taking any action. Thanks + to Dietrich Daroch. diff --git a/docs/plugins/convert.rst b/docs/plugins/convert.rst index 485c80400..b94f874d7 100644 --- a/docs/plugins/convert.rst +++ b/docs/plugins/convert.rst @@ -36,14 +36,15 @@ and customize the available commands The ``-a`` (or ``--album``) option causes the command to match albums instead of tracks. -The ``-t`` (``--threads``) option allows you to specify or overwrite -the respective configuration option. - By default, the command places converted files into the destination directory and leaves your library pristine. To instead back up your original files into the destination directory and keep converted files in your library, use the ``-k`` (or ``--keep-new``) option. +To test your configuration without taking any actions, use the ``--pretend`` +flag. The plugin will print out the commands it will run instead of executing +them. + Configuration -------------