richardphibel / rpms / systemd

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