From 4a8bc4fd079b0ea3adf610d2b5ab6a8ceb10d4ce Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Mon, 27 Jun 2022 17:21:34 +0200
Subject: lib/options: Add hint for debugging infinite recursion in docs

---
 lib/options.nix | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'lib/options.nix')

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);
 
 
-- 
cgit 1.4.1