lib/modules.nix: Add comment about internal shorthand null value

2022-03-07 11:23:24 +01:00 · 2022-03-07 11:23:24 +01:00 · c4b38702e5
commit c4b38702e5
parent c90844aeb9
1 changed files with 3 additions and 0 deletions
--- 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;
              };
            };