nixos/lvm: expand enable description to better inform users about the… (#355463)

2024-11-27 22:37:48 +01:00 · 2024-11-27 22:37:48 +01:00 · b5ad44e06e
commit b5ad44e06e
parent 1cd3957e37 a9f3a296d3
1 changed files with 7 additions and 0 deletions
--- a/nixos/modules/tasks/lvm.nix
+++ b/nixos/modules/tasks/lvm.nix
@ -7,6 +7,13 @@ in {
  options.services.lvm = {
    enable = mkEnableOption "lvm2" // {
      default = true;
+      description = ''
+        Whether to enable lvm2.
+
+        :::{.note}
+        The lvm2 package contains device-mapper udev rules and without those tools like cryptsetup do not fully function!
+        :::
+      '';
    };

    package = mkOption {