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

1 files changed, 2 insertions, 0 deletions

diff --git a/lib/options.nix b/lib/options.nix
index afae1769afdd4..3a1c0e540d7c0 100644
--- 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);