From f10de6c2c481ce9c62958138163e82414955c48d Mon Sep 17 00:00:00 2001
From: colin <colin@uninsane.org>
Date: Sun, 8 Jan 2023 06:54:29 +0000
Subject: [PATCH] ids: improve docs

---
 modules/ids.nix | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/modules/ids.nix b/modules/ids.nix
index ae743b4c..b289eda5 100644
--- a/modules/ids.nix
+++ b/modules/ids.nix
@@ -43,7 +43,12 @@ in
     sane.ids = mkOption {
       type = types.attrsOf id;
       default = {};
+      description = ''
+        mapping from user/group name to gids/uids you expect that entity to have.
+        for users/groups created elsewhere *without* an id, this is used to provide them a fixed/stable id.
+      '';
     };
+    # these get merged with the nixpkgs options.
     users.users = mkOption {
       type = types.attrsOf (types.submodule userOpts);
     };