summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorSilvan Mosberger <contact@infinisil.com>2020-01-08 23:59:37 +0100
committerSilvan Mosberger <contact@infinisil.com>2020-01-09 16:47:53 +0100
commit9d4b59b54949f0849ab9db9d30bc4cce7a205787 (patch)
tree17126aa97407974c38482a405508bc17feca660b /nixos/doc
parent6525da6321a7272faa0c2b1c15ffd3501888e9b9 (diff)
downloadnixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar.gz
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar.bz2
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar.lz
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar.xz
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.tar.zst
nixpkgs-9d4b59b54949f0849ab9db9d30bc4cce7a205787.zip
nixos/doc: Add incompatibility note for `either submodule path`
Co-Authored-By: Robert Hensing <roberth@users.noreply.github.com>
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/release-notes/rl-2003.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/nixos/doc/manual/release-notes/rl-2003.xml b/nixos/doc/manual/release-notes/rl-2003.xml
index ca319dfea41..51f91268eff 100644
--- a/nixos/doc/manual/release-notes/rl-2003.xml
+++ b/nixos/doc/manual/release-notes/rl-2003.xml
@@ -391,6 +391,16 @@ users.users.me =
      <link xlink:href="https://github.com/NixOS/nixpkgs/pull/63103">PR #63103</link>.
     </para>
    </listitem>
+   <listitem>
+    <para>
+     For NixOS modules, the types <literal>types.submodule</literal> and <literal>types.submoduleWith</literal> now support
+     paths as allowed values, similar to how <literal>imports</literal> supports paths.
+     Because of this, if you have a module that defines an option of type
+     <literal>either (submodule ...) path</literal>, it will break since a path
+     is now treated as the first type instead of the second. To fix this, change
+     the type to <literal>either path (submodule ...)</literal>.
+    </para>
+   </listitem>
   </itemizedlist>
  </section>