commit 4c10e0ff9ddea45b344134228dd5874b9ae0bd06 · pyrox.dev/nixpkgs

+1 -1

nixos/doc/manual/configuration/configuration.xml

···

       16
        
        <xi:include href="../from_md/configuration/config-syntax.chapter.xml" />

     

       17
        
        <xi:include href="../from_md/configuration/package-mgmt.chapter.xml" />

     

       18
        
        <xi:include href="../from_md/configuration/user-mgmt.chapter.xml" />

     

       19
       -
        <xi:include href="file-systems.xml" />

     

       20
        
        <xi:include href="../from_md/configuration/x-windows.chapter.xml" />

     

       21
        
        <xi:include href="../from_md/configuration/wayland.chapter.xml" />

     

       22
        
        <xi:include href="../from_md/configuration/gpu-accel.chapter.xml" />

···

       16
        
        <xi:include href="../from_md/configuration/config-syntax.chapter.xml" />

     

       17
        
        <xi:include href="../from_md/configuration/package-mgmt.chapter.xml" />

     

       18
        
        <xi:include href="../from_md/configuration/user-mgmt.chapter.xml" />

     

       19
       +
        <xi:include href="../from_md/configuration/file-systems.chapter.xml" />

     

       20
        
        <xi:include href="../from_md/configuration/x-windows.chapter.xml" />

     

       21
        
        <xi:include href="../from_md/configuration/wayland.chapter.xml" />

     

       22
        
        <xi:include href="../from_md/configuration/gpu-accel.chapter.xml" />

+42

nixos/doc/manual/configuration/file-systems.chapter.md

···

       1
       +
       # File Systems {#ch-file-systems}

     

       2
       +
       

     

       3
       +
       You can define file systems using the `fileSystems` configuration

     

       4
       +
       option. For instance, the following definition causes NixOS to mount the

     

       5
       +
       Ext4 file system on device `/dev/disk/by-label/data` onto the mount

     

       6
       +
       point `/data`:

     

       7
       +
       

     

       8
       +
       ```nix

     

       9
       +
       fileSystems."/data" =

     

       10
       +
         { device = "/dev/disk/by-label/data";

     

       11
       +
           fsType = "ext4";

     

       12
       +
         };

     

       13
       +
       ```

     

       14
       +
       

     

       15
       +
       This will create an entry in `/etc/fstab`, which will generate a

     

       16
       +
       corresponding [systemd.mount](https://www.freedesktop.org/software/systemd/man/systemd.mount.html)

     

       17
       +
       unit via [systemd-fstab-generator](https://www.freedesktop.org/software/systemd/man/systemd-fstab-generator.html).

     

       18
       +
       The filesystem will be mounted automatically unless `"noauto"` is

     

       19
       +
       present in [options](#opt-fileSystems._name_.options). `"noauto"`

     

       20
       +
       filesystems can be mounted explicitly using `systemctl` e.g.

     

       21
       +
       `systemctl start data.mount`. Mount points are created automatically if they don't

     

       22
       +
       already exist. For `device`, it's best to use the topology-independent

     

       23
       +
       device aliases in `/dev/disk/by-label` and `/dev/disk/by-uuid`, as these

     

       24
       +
       don't change if the topology changes (e.g. if a disk is moved to another

     

       25
       +
       IDE controller).

     

       26
       +
       

     

       27
       +
       You can usually omit the file system type (`fsType`), since `mount` can

     

       28
       +
       usually detect the type and load the necessary kernel module

     

       29
       +
       automatically. However, if the file system is needed at early boot (in

     

       30
       +
       the initial ramdisk) and is not `ext2`, `ext3` or `ext4`, then it's best

     

       31
       +
       to specify `fsType` to ensure that the kernel module is available.

     

       32
       +
       

     

       33
       +
       ::: {.note}

     

       34
       +
       System startup will fail if any of the filesystems fails to mount,

     

       35
       +
       dropping you to the emergency shell. You can make a mount asynchronous

     

       36
       +
       and non-critical by adding `options = [ "nofail" ];`.

     

       37
       +
       :::

     

       38
       +
       

     

       39
       +
       ```{=docbook}

     

       40
       +
       <xi:include href="luks-file-systems.section.xml" />

     

       41
       +
       <xi:include href="sshfs-file-systems.section.xml" />

     

       42
       +
       ```

-58

nixos/doc/manual/configuration/file-systems.xml

···

       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       -
                version="5.0"

     

       5
       -
                xml:id="ch-file-systems">

     

       6
       -
        <title>File Systems</title>

     

       7
       -
        <para>

     

       8
       -
         You can define file systems using the <option>fileSystems</option>

     

       9
       -
         configuration option. For instance, the following definition causes NixOS to

     

       10
       -
         mount the Ext4 file system on device

     

       11
       -
         <filename>/dev/disk/by-label/data</filename> onto the mount point

     

       12
       -
         <filename>/data</filename>:

     

       13
       -
       <programlisting>

     

       14
       -
       <xref linkend="opt-fileSystems"/>."/data" =

     

       15
       -
         { device = "/dev/disk/by-label/data";

     

       16
       -
           fsType = "ext4";

     

       17
       -
         };

     

       18
       -
       </programlisting>

     

       19
       -
         This will create an entry in <filename>/etc/fstab</filename>, which will

     

       20
       -
         generate a corresponding

     

       21
       -
         <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.mount.html">systemd.mount</link>

     

       22
       -
         unit via

     

       23
       -
         <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd-fstab-generator.html">systemd-fstab-generator</link>.

     

       24
       -
         The filesystem will be mounted automatically unless

     

       25
       -
         <literal>"noauto"</literal> is present in <link

     

       26
       -
         linkend="opt-fileSystems._name_.options">options</link>.

     

       27
       -
         <literal>"noauto"</literal> filesystems can be mounted explicitly using

     

       28
       -
         <command>systemctl</command> e.g. <command>systemctl start

     

       29
       -
         data.mount</command>.

     

       30
       -
         Mount points are created automatically if they don’t already exist. For

     

       31
       -
         <option><link linkend="opt-fileSystems._name_.device">device</link></option>,

     

       32
       -
         it’s best to use the topology-independent device aliases in

     

       33
       -
         <filename>/dev/disk/by-label</filename> and

     

       34
       -
         <filename>/dev/disk/by-uuid</filename>, as these don’t change if the

     

       35
       -
         topology changes (e.g. if a disk is moved to another IDE controller).

     

       36
       -
        </para>

     

       37
       -
        <para>

     

       38
       -
         You can usually omit the file system type

     

       39
       -
         (<option><link linkend="opt-fileSystems._name_.fsType">fsType</link></option>),

     

       40
       -
         since <command>mount</command> can usually detect the type and load the

     

       41
       -
         necessary kernel module automatically. However, if the file system is needed

     

       42
       -
         at early boot (in the initial ramdisk) and is not <literal>ext2</literal>,

     

       43
       -
         <literal>ext3</literal> or <literal>ext4</literal>, then it’s best to

     

       44
       -
         specify <option>fsType</option> to ensure that the kernel module is

     

       45
       -
         available.

     

       46
       -
        </para>

     

       47
       -
        <note>

     

       48
       -
         <para>

     

       49
       -
          System startup will fail if any of the filesystems fails to mount, dropping

     

       50
       -
          you to the emergency shell. You can make a mount asynchronous and

     

       51
       -
          non-critical by adding

     

       52
       -
          <literal><link linkend="opt-fileSystems._name_.options">options</link> = [

     

       53
       -
          "nofail" ];</literal>.

     

       54
       -
         </para>

     

       55
       -
        </note>

     

       56
       -
        <xi:include href="../from_md/configuration/luks-file-systems.section.xml" />

     

       57
       -
        <xi:include href="../from_md/configuration/sshfs-file-systems.section.xml" />

     

       58
       -
       </chapter>

+55

nixos/doc/manual/from_md/configuration/file-systems.chapter.xml

···

       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook"  xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="ch-file-systems">

     

       2
       +
         <title>File Systems</title>

     

       3
       +
         <para>

     

       4
       +
           You can define file systems using the <literal>fileSystems</literal>

     

       5
       +
           configuration option. For instance, the following definition causes

     

       6
       +
           NixOS to mount the Ext4 file system on device

     

       7
       +
           <literal>/dev/disk/by-label/data</literal> onto the mount point

     

       8
       +
           <literal>/data</literal>:

     

       9
       +
         </para>

     

       10
       +
         <programlisting language="bash">

     

       11
       +
       fileSystems.&quot;/data&quot; =

     

       12
       +
         { device = &quot;/dev/disk/by-label/data&quot;;

     

       13
       +
           fsType = &quot;ext4&quot;;

     

       14
       +
         };

     

       15
       +
       </programlisting>

     

       16
       +
         <para>

     

       17
       +
           This will create an entry in <literal>/etc/fstab</literal>, which

     

       18
       +
           will generate a corresponding

     

       19
       +
           <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.mount.html">systemd.mount</link>

     

       20
       +
           unit via

     

       21
       +
           <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd-fstab-generator.html">systemd-fstab-generator</link>.

     

       22
       +
           The filesystem will be mounted automatically unless

     

       23
       +
           <literal>&quot;noauto&quot;</literal> is present in

     

       24
       +
           <link linkend="opt-fileSystems._name_.options">options</link>.

     

       25
       +
           <literal>&quot;noauto&quot;</literal> filesystems can be mounted

     

       26
       +
           explicitly using <literal>systemctl</literal> e.g.

     

       27
       +
           <literal>systemctl start data.mount</literal>. Mount points are

     

       28
       +
           created automatically if they don’t already exist. For

     

       29
       +
           <literal>device</literal>, it’s best to use the topology-independent

     

       30
       +
           device aliases in <literal>/dev/disk/by-label</literal> and

     

       31
       +
           <literal>/dev/disk/by-uuid</literal>, as these don’t change if the

     

       32
       +
           topology changes (e.g. if a disk is moved to another IDE

     

       33
       +
           controller).

     

       34
       +
         </para>

     

       35
       +
         <para>

     

       36
       +
           You can usually omit the file system type

     

       37
       +
           (<literal>fsType</literal>), since <literal>mount</literal> can

     

       38
       +
           usually detect the type and load the necessary kernel module

     

       39
       +
           automatically. However, if the file system is needed at early boot

     

       40
       +
           (in the initial ramdisk) and is not <literal>ext2</literal>,

     

       41
       +
           <literal>ext3</literal> or <literal>ext4</literal>, then it’s best

     

       42
       +
           to specify <literal>fsType</literal> to ensure that the kernel

     

       43
       +
           module is available.

     

       44
       +
         </para>

     

       45
       +
         <note>

     

       46
       +
           <para>

     

       47
       +
             System startup will fail if any of the filesystems fails to mount,

     

       48
       +
             dropping you to the emergency shell. You can make a mount

     

       49
       +
             asynchronous and non-critical by adding

     

       50
       +
             <literal>options = [ &quot;nofail&quot; ];</literal>.

     

       51
       +
           </para>

     

       52
       +
         </note>

     

       53
       +
         <xi:include href="luks-file-systems.section.xml" />

     

       54
       +
         <xi:include href="sshfs-file-systems.section.xml" />

     

       55
       +
       </chapter>