From a9f3a296d311b1a08fffafad4f53fbd240d5b9e7 Mon Sep 17 00:00:00 2001
From: Sandro <sandro.jaeckel@gmail.com>
Date: Tue, 12 Nov 2024 16:54:14 +0100
Subject: [PATCH] nixos/lvm: expand enable description to better inform users
 about their actions

---
 nixos/modules/tasks/lvm.nix | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/nixos/modules/tasks/lvm.nix b/nixos/modules/tasks/lvm.nix
index 4d1018978eaf..f72aa5fc0a7c 100644
--- 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 {