572a44
From 9395355f4733cecc72b31f384e313606745c14d2 Mon Sep 17 00:00:00 2001
572a44
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
572a44
Date: Wed, 25 Dec 2013 23:20:57 -0500
572a44
Subject: [PATCH] man: document fail/nofail, auto/noauto
572a44
572a44
Also s/filesystem/file system/ in a few places.
572a44
572a44
Conflicts:
572a44
	TODO
572a44
	man/systemd-fsck@.service.xml
572a44
	man/systemd-fstab-generator.xml
572a44
---
572a44
 man/systemd-fsck@.service.xml   |  5 ++++-
572a44
 man/systemd-fstab-generator.xml |  6 ++++++
572a44
 man/systemd-halt.service.xml    |  2 +-
572a44
 man/systemd.mount.xml           | 20 +++++++++++++++++++-
572a44
 man/systemd.unit.xml            |  2 +-
572a44
 man/udevadm.xml                 |  2 +-
572a44
 6 files changed, 32 insertions(+), 5 deletions(-)
572a44
572a44
diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml
572a44
index e934352..c653dc5 100644
572a44
--- a/man/systemd-fsck@.service.xml
572a44
+++ b/man/systemd-fsck@.service.xml
572a44
@@ -62,7 +62,10 @@
572a44
                 system
572a44
                 check. <filename>systemd-fsck-root.service</filename> is
572a44
                 responsible for file system checks on the root
572a44
-                file system.</para>
572a44
+                file system. The root file system check is performed
572a44
+                before the other file systems. Either service is enabled
572a44
+                at boot if passno in <filename>/etc/fstab</filename> for
572a44
+                the file system is set to a value greater than zero.</para>
572a44
 
572a44
                 <para><filename>systemd-fsck</filename> will
572a44
                 forward file system checking progress to the
572a44
diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml
572a44
index 9ca16c7..e3cf5d2 100644
572a44
--- a/man/systemd-fstab-generator.xml
572a44
+++ b/man/systemd-fstab-generator.xml
572a44
@@ -61,6 +61,12 @@
572a44
                 reloaded. This will instantiate mount and swap units
572a44
                 as necessary.</para>
572a44
 
572a44
+                <para>The <varname>passno</varname> field is treated
572a44
+                like a simple boolean, and the ordering information is
572a44
+                discarded. However, if the root file system is
572a44
+                checked, it is checked before all the other
572a44
+                file systems.</para>
572a44
+
572a44
                 <para>See
572a44
                 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
572a44
                 and
572a44
diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml
572a44
index 99457aa..bec2e36 100644
572a44
--- a/man/systemd-halt.service.xml
572a44
+++ b/man/systemd-halt.service.xml
572a44
@@ -86,7 +86,7 @@
572a44
                 <para>It is necessary to have this code in a separate binary
572a44
                 because otherwise rebooting after an upgrade might be broken —
572a44
                 the running PID 1 could still depend on libraries which are not
572a44
-                available any more, thus keeping the filesystem busy, which
572a44
+                available any more, thus keeping the file system busy, which
572a44
                 then cannot be re-mounted read-only.</para>
572a44
 
572a44
                 <para>Immediately before executing the actual system
572a44
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
572a44
index 6f9f70c..cadf950 100644
572a44
--- a/man/systemd.mount.xml
572a44
+++ b/man/systemd.mount.xml
572a44
@@ -132,7 +132,10 @@
572a44
                 for details). Mounts listed in
572a44
                 <filename>/etc/fstab</filename> will be converted into
572a44
                 native units dynamically at boot and when the
572a44
-                configuration of the system manager is reloaded. See
572a44
+                configuration of the system manager is reloaded. In
572a44
+                general, configuring mount points through
572a44
+                <filename>/etc/fstab</filename> is the preferred
572a44
+                approach. See
572a44
                 <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
572a44
                 for details about the conversion.</para>
572a44
 
572a44
@@ -159,6 +162,21 @@
572a44
                 <literal>s</literal>, <literal>min</literal>,
572a44
                 <literal>h</literal>, <literal>ms</literal>.</para>
572a44
 
572a44
+                <para>If <option>nofail</option> is given, this mount
572a44
+                will be only wanted, not required, by the
572a44
+                <filename>local-fs.target</filename>. This means that
572a44
+                the boot will continue even if this mount point is not
572a44
+                mounted successfully. Option <option>fail</option> has
572a44
+                the opposite meaning and is the default.</para>
572a44
+
572a44
+                <para>If <option>noauto</option> is given, this mount
572a44
+                will not be added as a dependency for
572a44
+                <filename>local-fs.target</filename>. This means that
572a44
+                it will not be mounted automatically during boot,
572a44
+                unless it is pulled in by some other unit. Option
572a44
+                <option>auto</option> has the opposite meaning and is
572a44
+                the default.</para>
572a44
+
572a44
                 <para>If a mount point is configured in both
572a44
                 <filename>/etc/fstab</filename> and a unit file that
572a44
                 is stored below <filename>/usr</filename>, the former
572a44
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
572a44
index f6b4b24..4704352 100644
572a44
--- a/man/systemd.unit.xml
572a44
+++ b/man/systemd.unit.xml
572a44
@@ -232,7 +232,7 @@
572a44
                 multiple units from a single configuration file. If
572a44
                 systemd looks for a unit configuration file, it will
572a44
                 first search for the literal unit name in the
572a44
-                filesystem. If that yields no success and the unit
572a44
+                file system. If that yields no success and the unit
572a44
                 name contains an <literal>@</literal> character, systemd will look for a
572a44
                 unit template that shares the same name but with the
572a44
                 instance string (i.e. the part between the <literal>@</literal> character
572a44
diff --git a/man/udevadm.xml b/man/udevadm.xml
572a44
index a1ffe42..ca3713f 100644
572a44
--- a/man/udevadm.xml
572a44
+++ b/man/udevadm.xml
572a44
@@ -461,7 +461,7 @@
572a44
         <varlistentry>
572a44
           <term><option>--root=<replaceable>string</replaceable></option></term>
572a44
           <listitem>
572a44
-            <para>Alternative root path in the filesystem for reading and writing files.</para>
572a44
+            <para>Alternative root path in the file system for reading and writing files.</para>
572a44
           </listitem>
572a44
         </varlistentry>
572a44
       </variablelist>