lib/options: Add hint for debugging infinite recursion in docs

raja · Jun 27, 2022 · 4a8bc4f · 4a8bc4f
1 parent 4923701
commit 4a8bc4f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lib/options.nix b/lib/options.nix
@@ -242,6 +242,8 @@ rec {
           in if ss != {} then optionAttrSetToDocList' opt.loc ss else [];
         subOptionsVisible = docOption.visible && opt.visible or null != "shallow";
       in
+        # To find infinite recursion in NixOS option docs:
+        # builtins.trace opt.loc
         [ docOption ] ++ optionals subOptionsVisible subOptions) (collect isOption options);