importadded: adapt doc for new option preserve_write_mtimes

This commit is contained in:
Cédric Tissières 2016-03-22 06:24:09 +01:00
parent 8ef36198fb
commit e5be804802
3 changed files with 15 additions and 6 deletions

View file

@ -8,6 +8,8 @@ New features:
* :doc:`/plugins/convert`: A new `album_art_maxwidth` lets you resize album
art while copying it.
* :doc:`/plugins/importadded`: A new `preserve_write_mtimes` option
lets you preserve mtime of files after each write.
Fixes:

View file

@ -22,8 +22,11 @@ The ``item.added`` field is populated as follows:
set to the oldest mtime of the files in the album before they were imported.
The mtime of album directories is ignored.
This plugin can optionally be configured to also preserve mtimes using the
``preserve_mtimes`` option.
This plugin can optionally be configured to also preserve mtimes at
import using the ``preserve_mtimes`` option.
When ``preserve_write_mtimes`` option is set, this plugin preserves
mtimes after each write to files using the ``item.added`` attribute.
File modification times are preserved as follows:
@ -40,9 +43,13 @@ Configuration
-------------
To configure the plugin, make an ``importadded:`` section in your
configuration file. There is one option available:
configuration file. There are two options available:
- **preserve_mtimes**: After writing files, re-set their mtimes to their
- **preserve_mtimes**: After importing files, re-set their mtimes to their
original value.
Default: ``no``.
- **preserve_write_mtimes**: After writing files, re-set their mtimes to their
original value.
Default: ``no``.