From 13383f1e23d81111f4d17bde4337ac1e1cd763d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Na=C3=AFm=20Favier?= <n@monade.li>
Date: Tue, 28 Feb 2023 15:14:16 +0100
Subject: [PATCH] lib/types: allow changing the name of `name`

Adds a new `nameArgument` argument to `submoduleWith` that allows
changing which argument the "name" (last item of `loc`, i.e. attribute
name or option name this submodule appears under) is bound to.

This avoids conflicts when `moduleType` is used inside a submodule,
where `name` would be set to both the outer submodule's name and the
inner one's. If the outer submodule type sets `nameArgument` to
something different, `moduleType` will continue using `name`, avoiding
the conflict.

Ideally, there should probably be a way to change the inner `name` too
to remove all ambiguity.
---
 lib/types.nix | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/types.nix b/lib/types.nix
index 666e6502d161b..6f56145677f82 100644
--- a/lib/types.nix
+++ b/lib/types.nix
@@ -696,6 +696,7 @@ rec {
       , specialArgs ? {}
       , shorthandOnlyDefinesConfig ? false
       , description ? null
+      , nameArgument ? "name"
       }@attrs:
       let
         inherit (lib.modules) evalModules;
@@ -724,7 +725,7 @@ rec {
             # &gt; and &lt; wouldn't be encoded correctly so the encoded values
             # would be used, and use of `<` and `>` would break the XML document.
             # It shouldn't cause an issue since this is cosmetic for the manual.
-            _module.args.name = lib.mkOptionDefault "‹name›";
+            _module.args.${nameArgument} = lib.mkOptionDefault "‹name›";
           }] ++ modules;
         };
 
@@ -741,7 +742,7 @@ rec {
         check = x: isAttrs x || isFunction x || path.check x;
         merge = loc: defs:
           (base.extendModules {
-            modules = [ { _module.args.name = last loc; } ] ++ allModules defs;
+            modules = [ { _module.args.${nameArgument} = last loc; } ] ++ allModules defs;
             prefix = loc;
           }).config;
         emptyValue = { value = {}; };