summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-12-01 22:58:31 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-12-03 23:52:39 +0100
commitf0c5cda25150d49f9433408e08ed689a92395df2 (patch)
tree0f24b85ffb315f7d0db2aad6aed519e50004f6aa
parentde59724865767b688bb13b04f0c78ec5abc37867 (diff)
downloadsystemd-f0c5cda25150d49f9433408e08ed689a92395df2.tar.gz
man: add missing descriptions of fstab options to systemd.swap(5)
-rw-r--r--man/systemd.mount.xml4
-rw-r--r--man/systemd.swap.xml24
2 files changed, 25 insertions, 3 deletions
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index daee201eeb..abd43ee684 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -263,7 +263,7 @@
for details.</para></listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id='device-timeout'>
<term><option>x-systemd.device-timeout=</option></term>
<listitem><para>Configure how long systemd should wait for a
@@ -303,7 +303,7 @@
<varlistentry>
<term><option>x-systemd.makefs</option></term>
- <listitem><para>The file system or swap structure will be initialized
+ <listitem><para>The file system will be initialized
on the device. If the device is not "empty", i.e. it contains any signature,
the operation will be skipped. It is hence expected that this option
remains set even after the device has been initalized.</para>
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 998a047ec5..073c2b3a27 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -6,7 +6,9 @@
SPDX-License-Identifier: LGPL-2.1+
-->
-<refentry id="systemd.swap">
+<refentry id="systemd.swap"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+
<refentryinfo>
<title>systemd.swap</title>
<productname>systemd</productname>
@@ -141,6 +143,26 @@
successfully.</para>
</listitem>
</varlistentry>
+
+ <xi:include href="systemd.mount.xml" xpointer="device-timeout" />
+
+ <varlistentry>
+ <term><option>x-systemd.makefs</option></term>
+
+ <listitem><para>The swap structure will be initialized on the device. If the device is not
+ "empty", i.e. it contains any signature, the operation will be skipped. It is hence expected
+ that this option remains set even after the device has been initalized.</para>
+
+ <para>Note that this option can only be used in <filename>/etc/fstab</filename>, and will be
+ ignored when part of the <varname>Options=</varname> setting in a unit file.</para>
+
+ <para>See
+ <citerefentry><refentrytitle>systemd-mkswap@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ and the discussion of
+ <citerefentry project='man-pages'><refentrytitle>wipefs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ in <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para></listitem>
+ </varlistentry>
</variablelist>
</refsect1>