Skip to content

Commit 9e5f168

Browse files
committed
lastgenre: Docs for blacklist feature
1 parent 1748d07 commit 9e5f168

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

docs/plugins/lastgenre.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,34 @@ genres remain, set ``whitelist: no``).
161161
If ``force`` is disabled the ``keep_existing`` option is simply ignored
162162
(since ``force: no`` means ``not touching`` existing tags anyway).
163163

164+
Blacklisting Genres
165+
-------------------
166+
If you want to blacklist certain genres, they could simply be removed from the
167+
``whitelist``. This way, they will never be fetched from Last.fm. To only forbid them
168+
for a specific artist, the ``blacklist`` can be used. A possible ``blacklist`` file would
169+
look like this:
170+
171+
.. code-block:: text
172+
173+
fracture:
174+
^(heavy|black|power|death)?\s?(metal|rock)$|\w+-metal\d*$
175+
progressive metal
176+
gilles peterson:
177+
samba
178+
bossa nova
179+
*:
180+
electronic
181+
182+
A combination of regex patterns and plain genre names is possible. The ``*`` key matches
183+
all artists that are not explicitly defined, which is effectively the same as removing
184+
them from the whitelist (helpful if the default whitelist is desired to be kept).
185+
186+
Set the ``blacklist`` option to the path of a blacklist file to enable this feature.
187+
188+
.. attention::
189+
Do not use single or double quotes around the genre names or regex patterns.
190+
191+
164192
Configuration
165193
-------------
166194

@@ -201,7 +229,11 @@ file. The available options are:
201229
last.fm tags were fetched for tracks, albums and artists. This is done before
202230
any canonicalization and whitelist filtering is applied. It's useful for
203231
tuning the plugin's settings and understanding how it works, but it can be
204-
quite verbose. Default: ``no``.
232+
quite verbose.
233+
Default: ``no``.
234+
- **blacklist**: The path to a blacklist file that contains genres to exclude from being
235+
set as genres for specific artists. See `Blacklisting Genres`_ for more details.
236+
Default: ``no``.
205237

206238
Running Manually
207239
----------------

0 commit comments

Comments
 (0)