Skip to content

Commit 5b24d49

Browse files
committed
lastgenre: Docs for blacklist feature
1 parent 0243a4a commit 5b24d49

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/plugins/lastgenre.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,33 @@ make sure any existing genres remain, set ``whitelist: no``).
158158
no`` means `not touching` existing tags anyway).
159159

160160

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

162189
Configuration
163190
-------------
@@ -210,6 +237,9 @@ configuration file. The available options are:
210237
tuning the plugin's settings and understanding how it works, but it can be
211238
quite verbose.
212239
Default: ``no``.
240+
- **blacklist**: The path to a blacklist file that contains genres to exclude from being
241+
set as genres for specific artists. See `Blacklisting Genres`_ for more details.
242+
Default: ``no``.
213243

214244
Running Manually
215245
----------------

0 commit comments

Comments
 (0)