From 319b012b9dbda716c7ed3c0465aeff087cce7d94 Mon Sep 17 00:00:00 2001
From: Bert Proesmans <bproesmans@hotmail.com>
Date: Sun, 23 Mar 2025 09:56:41 +0000
Subject: [PATCH] options-manual: Remove `users` option set from documentation

The option declaration `users.users` is owned by the upstream
nixos modules and should not be documented by home-manager.

Home-manager declares an incomplete/partial option definition for
`users.users` that cannot be documented without the full definition from
the nixos modules. This partial definition is removed from the options
set while generating documentation for the home-manager nixos module.
---
 docs/default.nix | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/docs/default.nix b/docs/default.nix
index dd79c4590..63b60a16d 100644
--- a/docs/default.nix
+++ b/docs/default.nix
@@ -54,17 +54,17 @@ let
 
   hmPath = toString ./..;
 
-  buildOptionsDocs = args@{ modules, includeModuleSystemOptions ? true, ... }:
+  buildOptionsDocs =
+    args@{ modules, includeModuleSystemOptions ? true, isNixos ? false, ... }:
     let
       options = (lib.evalModules {
         inherit modules;
         class = "homeManager";
       }).options;
     in pkgs.buildPackages.nixosOptionsDoc ({
-      options = if includeModuleSystemOptions then
-        options
-      else
-        builtins.removeAttrs options [ "_module" ];
+      options = builtins.removeAttrs options ([ ]
+        ++ (lib.optional (!includeModuleSystemOptions) "_module")
+        ++ (lib.optional (isNixos) "users"));
       transformOptions = opt:
         opt // {
           # Clean up declaration sites to not refer to the Home Manager
@@ -80,7 +80,11 @@ let
             else
               decl) opt.declarations;
         };
-    } // builtins.removeAttrs args [ "modules" "includeModuleSystemOptions" ]);
+    } // builtins.removeAttrs args [
+      "modules"
+      "includeModuleSystemOptions"
+      "isNixos"
+    ]);
 
   hmOptionsDocs = buildOptionsDocs {
     modules = import ../modules/modules.nix {
@@ -93,6 +97,7 @@ let
   nixosOptionsDocs = buildOptionsDocs {
     modules = [ ../nixos scrubbedPkgsModule dontCheckDefinitions ];
     includeModuleSystemOptions = false;
+    isNixos = true;
     variablelistId = "nixos-options";
     optionIdPrefix = "nixos-opt-";
   };
@@ -100,6 +105,7 @@ let
   nixDarwinOptionsDocs = buildOptionsDocs {
     modules = [ ../nix-darwin scrubbedPkgsModule dontCheckDefinitions ];
     includeModuleSystemOptions = false;
+    isNixos = true;
     variablelistId = "nix-darwin-options";
     optionIdPrefix = "nix-darwin-opt-";
   };