From c4b38702e59ea156924d3297e3f7ec80f7f816cb Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Mon, 7 Mar 2022 11:23:24 +0100
Subject: lib/modules.nix: Add comment about internal shorthand null value

---
 lib/modules.nix | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'lib/modules.nix')

diff --git a/lib/modules.nix b/lib/modules.nix
index 5d1532af623..25cd5921dec 100644
--- a/lib/modules.nix
+++ b/lib/modules.nix
@@ -496,6 +496,9 @@ rec {
             options = mkOption {
               type = types.submoduleWith {
                 modules = [ { options = decl.options; } ];
+                # `null` is not intended for use by modules. It is an internal
+                # value that means "whatever the user has declared elsewhere".
+                # This might become obsolete with https://github.com/NixOS/nixpkgs/issues/162398
                 shorthandOnlyDefinesConfig = null;
               };
             };
-- 
cgit 1.4.1