beets: document pluginOverrides

2022-05-09 12:20:20 -07:00
parent 6eab16313f
commit 069410f90b
1 changed files with 13 additions and 1 deletions
@@ -2,7 +2,19 @@
 , callPackage
 , fetchFromGitHub
 }:
-
+/*
+** To customize the enabled beets plugins, use the pluginOverrides input to the
+** derivation.
+** Examples:
+**
+** Disabling a builtin plugin:
+** beets.override { pluginOverrides = { beatport.enable = false; }; }
+**
+** Enabling an external plugin:
+** beets.override { pluginOverrides = {
+**   alternatives = { enable = true; propagatedBuildInputs = [ beetsPackages.alternatives ]; };
+** }; }
+*/
 lib.makeExtensible (self: {
  beets = self.beets-stable;