nixos/firmware: mention enableAllFirmware including unfree packages

2025-09-30 19:48:01 +02:00
parent 8f1b798f6a
commit aa047cc668
1 changed files with 12 additions and 1 deletions
@@ -36,7 +36,18 @@ in

  options = {

-    hardware.enableAllFirmware = lib.mkEnableOption "all firmware regardless of license";
+    hardware.enableAllFirmware = lib.mkOption {
+      default = false;
+      example = true;
+
+      description = ''
+        Whether to enable all firmware, including [unfree packages that must be explictly allowed](https://nixos.org/manual/nixpkgs/unstable/#sec-allow-unfree).
+
+        Alternatively, use the {option}`hardware.enableRedistributableFirmware` option.
+      '';
+
+      type = lib.types.bool;
+    };

    hardware.enableRedistributableFirmware =
      lib.mkEnableOption "firmware with a license allowing redistribution"