summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorAneesh Agrawal <aneeshusa@gmail.com>2015-10-21 17:37:14 +0000
committerRobin Gloster <mail@glob.in>2016-02-06 19:48:30 +0000
commit3c5fca9618241334f40bfd2199cdfabb4fad55ec (patch)
treecfcf6aae28bfcd93df11019c9486255ffb440e31 /nixos/doc
parentf7aa92177355dc94d7e554cb6b089eb81cb320fa (diff)
downloadnixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar.gz
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar.bz2
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar.lz
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar.xz
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.tar.zst
nixlib-3c5fca9618241334f40bfd2199cdfabb4fad55ec.zip
filesystems: use list of strings for fs options
Allow usage of list of strings instead of a comma-separated string
for filesystem options. Deprecate the comma-separated string style
with a warning message; convert this to a hard error after 16.09.
15.09 was just released, so this provides a deprecation period during
the 16.03 release.

closes #10518

Signed-off-by: Robin Gloster <mail@glob.in>
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/configuration/config-file.xml2
-rw-r--r--nixos/doc/manual/man-nixos-generate-config.xml4
-rw-r--r--nixos/doc/manual/release-notes/rl-unstable.xml17
3 files changed, 20 insertions, 3 deletions
diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml
index b613c7f06cc8..9b240979273d 100644
--- a/nixos/doc/manual/configuration/config-file.xml
+++ b/nixos/doc/manual/configuration/config-file.xml
@@ -157,7 +157,7 @@ boot.kernel.sysctl."net.ipv4.tcp_keepalive_time" = 60;
 fileSystems."/boot" =
   { device = "/dev/sda1";
     fsType = "ext4";
-    options = "rw,data=ordered,relatime";
+    options = [ "rw" "data=ordered" "relatime" ];
   };
 </programlisting>
       </para>
diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml
index e4fba4a40a97..140642bc9c9c 100644
--- a/nixos/doc/manual/man-nixos-generate-config.xml
+++ b/nixos/doc/manual/man-nixos-generate-config.xml
@@ -165,13 +165,13 @@ look like this:
   fileSystems."/" =
     { device = "/dev/disk/by-label/nixos";
       fsType = "ext3";
-      options = "rw,data=ordered,relatime";
+      options = [ "rw" "data=ordered" "relatime" ];
     };
 
   fileSystems."/boot" =
     { device = "/dev/sda1";
       fsType = "ext3";
-      options = "rw,errors=continue,user_xattr,acl,barrier=1,data=writeback,relatime";
+      options = [ "rw" "errors=continue" "user_xattr" "acl" "barrier=1" "data=writeback" "relatime" ];
     };
 
   swapDevices =
diff --git a/nixos/doc/manual/release-notes/rl-unstable.xml b/nixos/doc/manual/release-notes/rl-unstable.xml
index 3d7819803697..c814d61bcf4c 100644
--- a/nixos/doc/manual/release-notes/rl-unstable.xml
+++ b/nixos/doc/manual/release-notes/rl-unstable.xml
@@ -155,6 +155,23 @@ nginx.override {
     rights, new <literal>aliasFiles</literal> and <literal>mapFiles</literal>
     options and more.</para>
   </listitem>
+
+  <listitem>
+    <para>Filesystem options should now be configured as a list of strings, not
+    a comma-separated string. The old style will continue to work, but print a
+    warning, until the 16.09 release. An example of the new style:
+
+<programlisting>
+fileSystems."/example" = {
+  device = "/dev/sdc";
+  fsType = "btrfs";
+  options = [ "noatime" "compress=lzo" "space_cache" "autodefrag" ];
+};
+</programlisting>
+
+    </para>
+  </listitem>
+
 </itemizedlist>