aboutsummaryrefslogtreecommitdiff
path: root/doc/release-notes
diff options
context:
space:
mode:
authorRobert Helgesson <robert@rycee.net>2020-01-13 22:34:38 +0100
committerRobert Helgesson <robert@rycee.net>2020-01-13 22:34:38 +0100
commitbff499113e4226707fac428b9aa435e31f2a2da9 (patch)
tree8b1d2a8666b319d233ab1d3aa695d654e04c4260 /doc/release-notes
parentee01d24a457c506c2d9663c002a63c1c81079277 (diff)
manual: note deprecation of list values for file options
In particular, this entry notes that assigning lists to `home.file`, `xdg.configFile`, and `xdg.dataFile` is deprecated and will be removed in the next release.
Diffstat (limited to 'doc/release-notes')
-rw-r--r--doc/release-notes/rl-2003.adoc27
1 files changed, 26 insertions, 1 deletions
diff --git a/doc/release-notes/rl-2003.adoc b/doc/release-notes/rl-2003.adoc
index b98428dbe47..29024205610 100644
--- a/doc/release-notes/rl-2003.adoc
+++ b/doc/release-notes/rl-2003.adoc
@@ -9,7 +9,32 @@ section is therefore not final.
This release has the following notable changes:
-* Nothing has happened.
+* Assigning a list to the <<opt-home.file>>, <<opt-xdg.configFile>>,
+and <<opt-xdg.dataFile>> options is now deprecated and will produce a
+warning message if used. Specifically, if your configuration currently
+contains something like
++
+[source,nix]
+----
+home.file = [
+ {
+ target = ".config/foo.txt";
+ text = "bar";
+ }
+]
+----
++
+then it should be updated to instead use the equivalent attribute set form
++
+[source,nix]
+----
+home.file = {
+ ".config/foo.txt".text = "bar";
+}
+----
++
+Support for the list form will be removed in Home Manager version
+20.09.
[[sec-release-20.03-state-version-changes]]
=== State Version Changes