From 2f8a8e2f8a5fc7859328196a3f14adb5c9ee2a4e Mon Sep 17 00:00:00 2001 From: Ryan Lanny Jenkins Date: Wed, 24 Mar 2021 16:55:28 -0500 Subject: [PATCH] Add docs for badfiles' `check_on_import` option. --- docs/plugins/badfiles.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/plugins/badfiles.rst b/docs/plugins/badfiles.rst index a59dbd0d1..796f991e1 100644 --- a/docs/plugins/badfiles.rst +++ b/docs/plugins/badfiles.rst @@ -17,6 +17,7 @@ install yourself: You can also add custom commands for a specific extension, like this:: badfiles: + check_on_import: yes commands: ogg: myoggchecker --opt1 --opt2 flac: flac --test --warnings-as-errors --silent @@ -25,6 +26,10 @@ Custom commands will be run once for each file of the specified type, with the path to the file as the last argument. Commands must return a status code greater than zero for a file to be considered corrupt. +You can run the checkers when importing files by using the `check_on_import` +option. When on, checkers will be run against every imported file and warnings +and errors will be presented when selecting a tagging option. + .. _mp3val: http://mp3val.sourceforge.net/ .. _flac: https://xiph.org/flac/