summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-12-25 23:20:57 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-12-25 23:22:05 -0500
commit72ebbf3450340338d71ea2039dfb296bc1d595db (patch)
tree336b6c4ec94d1dbc5f7505e00edd7722cd604ffc
parent8b8f259170e35b93e6c6d1757cb8b835bbdaa40c (diff)
man: document fail/nofail, auto/noauto
Also s/filesystem/file system/ in a few places.
-rw-r--r--TODO2
-rw-r--r--man/systemd-fsck@.service.xml2
-rw-r--r--man/systemd-fstab-generator.xml9
-rw-r--r--man/systemd-halt.service.xml2
-rw-r--r--man/systemd.mount.xml20
-rw-r--r--man/systemd.unit.xml2
-rw-r--r--man/udevadm.xml2
7 files changed, 28 insertions, 11 deletions
diff --git a/TODO b/TODO
index 0069a92413..e63463923d 100644
--- a/TODO
+++ b/TODO
@@ -101,8 +101,6 @@ Features:
Maybe take a BSD lock at the disk device node and teach udev to
check for that and suppress event handling.
-* document logic of auto/noauto and fail/nofail in fstab in systemd.mount or systemd-fstab-generator man page
-
* something pulls in pcre as shared object dependency into our daemons such as hostnamed.
* allow implementation of InaccessibleDirectories=/ plus
diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml
index 811392b19a..c653dc59d4 100644
--- a/man/systemd-fsck@.service.xml
+++ b/man/systemd-fsck@.service.xml
@@ -65,7 +65,7 @@
file system. The root file system check is performed
before the other file systems. Either service is enabled
at boot if passno in <filename>/etc/fstab</filename> for
- the filesystem is set to a value greater than zero.</para>
+ the file system is set to a value greater than zero.</para>
<para><filename>systemd-fsck</filename> will
forward file system checking progress to the
diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml
index 8996686e7a..e3cf5d2bfb 100644
--- a/man/systemd-fstab-generator.xml
+++ b/man/systemd-fstab-generator.xml
@@ -61,10 +61,11 @@
reloaded. This will instantiate mount and swap units
as necessary.</para>
- <para>The <varname>passno</varname> field
- is treated like a simple boolean, and the ordering information
- is discarded. However, the root filesystem is checked
- before all the other filesystems.</para>
+ <para>The <varname>passno</varname> field is treated
+ like a simple boolean, and the ordering information is
+ discarded. However, if the root file system is
+ checked, it is checked before all the other
+ file systems.</para>
<para>See
<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml
index a39253d8c0..552dbdf687 100644
--- a/man/systemd-halt.service.xml
+++ b/man/systemd-halt.service.xml
@@ -86,7 +86,7 @@
<para>It is necessary to have this code in a separate binary
because otherwise rebooting after an upgrade might be broken —
the running PID 1 could still depend on libraries which are not
- available any more, thus keeping the filesystem busy, which
+ available any more, thus keeping the file system busy, which
then cannot be re-mounted read-only.</para>
<para>Immediately before executing the actual system
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index b181949b13..657cf11be3 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -132,7 +132,10 @@
for details). Mounts listed in
<filename>/etc/fstab</filename> will be converted into
native units dynamically at boot and when the
- configuration of the system manager is reloaded. See
+ configuration of the system manager is reloaded. In
+ general, configuring mount points through
+ <filename>/etc/fstab</filename> is the preferred
+ approach. See
<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for details about the conversion.</para>
@@ -159,6 +162,21 @@
<literal>s</literal>, <literal>min</literal>,
<literal>h</literal>, <literal>ms</literal>.</para>
+ <para>If <option>nofail</option> is given, this mount
+ will be only wanted, not required, by the
+ <filename>local-fs.target</filename>. This means that
+ the boot will continue even if this mount point is not
+ mounted successfully. Option <option>fail</option> has
+ the opposite meaning and is the default.</para>
+
+ <para>If <option>noauto</option> is given, this mount
+ will not be added as a dependency for
+ <filename>local-fs.target</filename>. This means that
+ it will not be mounted automatically during boot,
+ unless it is pulled in by some other unit. Option
+ <option>auto</option> has the opposite meaning and is
+ the default.</para>
+
<para>If a mount point is configured in both
<filename>/etc/fstab</filename> and a unit file that
is stored below <filename>/usr</filename>, the former
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 487827cdde..2a965f5a1c 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -232,7 +232,7 @@
multiple units from a single configuration file. If
systemd looks for a unit configuration file, it will
first search for the literal unit name in the
- filesystem. If that yields no success and the unit
+ file system. If that yields no success and the unit
name contains an <literal>@</literal> character, systemd will look for a
unit template that shares the same name but with the
instance string (i.e. the part between the <literal>@</literal> character
diff --git a/man/udevadm.xml b/man/udevadm.xml
index 6fc4e8d50c..f5aafe50ba 100644
--- a/man/udevadm.xml
+++ b/man/udevadm.xml
@@ -528,7 +528,7 @@
<term><option>-r</option></term>
<term><option>--root=<replaceable>string</replaceable></option></term>
<listitem>
- <para>Alternative root path in the filesystem for reading and writing files.</para>
+ <para>Alternative root path in the file system for reading and writing files.</para>
</listitem>
</varlistentry>
<varlistentry>