Skip to content

Commit

Permalink
nixos/doc: Add incompatibility note for either submodule path
Browse files Browse the repository at this point in the history
Co-Authored-By: Robert Hensing <[email protected]>
  • Loading branch information
infinisil and roberth committed Jan 9, 2020
1 parent 6525da6 commit 9d4b59b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions nixos/doc/manual/release-notes/rl-2003.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down

0 comments on commit 9d4b59b

Please sign in to comment.