From aa047cc668e925fe6dbc8c4e5b166ff07fc0c038 Mon Sep 17 00:00:00 2001
From: NAHO <90870942+trueNAHO@users.noreply.github.com>
Date: Mon, 8 Sep 2025 20:38:44 +0200
Subject: [PATCH] nixos/firmware: mention enableAllFirmware including unfree
 packages

---
 nixos/modules/hardware/all-firmware.nix | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/nixos/modules/hardware/all-firmware.nix b/nixos/modules/hardware/all-firmware.nix
index 152b750edd08..3fea8fec4475 100644
--- a/nixos/modules/hardware/all-firmware.nix
+++ b/nixos/modules/hardware/all-firmware.nix
@@ -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"