man: describe better when remount-fs.service and gpt-auto-generator are active

This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2018-12-20 16:09:48 +01:00
parent 9b69569d2c
commit 17ec531ff0
4 changed files with 55 additions and 17 deletions

1
TODO
View File

@ -825,6 +825,7 @@ Features:
- man: document the very specific env the shutdown drop-in tools live in
- man: add more examples to man pages
- man: maybe sort directives in man pages, and take sections from --help and apply them to man too
- document root=gpt-auto properly
* systemctl:
- add systemctl switch to dump transaction without executing it

View File

@ -329,7 +329,7 @@
<listitem>
<para>Configures the root file system and its file system
type and mount options, as well as whether it shall be
mounted read-only or read-writable initially. For details,
mounted read-only or read-write initially. For details,
see
<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</listitem>

View File

@ -196,6 +196,45 @@
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>Kernel Command Line</title>
<para><filename>systemd-gpt-auto-generator</filename> understands the following kernel command line
parameters:</para>
<variablelist class='kernel-commandline-options'>
<varlistentry>
<term><varname>systemd.gpt_auto</varname></term>
<term><varname>rd.systemd.gpt_auto</varname></term>
<listitem><para>Those options take an optional boolean argument, and default to yes.
The generator is enabled by default, and a negative value may be used to disable it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>root=</varname></term>
<listitem><para>When used with the special value <literal>gpt-auto</literal>, automatic discovery of
the root parition based on the GPT partition type is enabled. Any other value disables this
generator.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>rw</varname></term>
<term><varname>ro</varname></term>
<listitem><para>Mount the root partition read-write or read-only <emphasis>initially</emphasis>.</para>
<para>Note that unlike most kernel command line options these settings do not override configuration
in the file system, and the file system may be remounted later. See
<citerefentry><refentrytitle>systemd-remount-fs.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>

View File

@ -30,22 +30,20 @@
<refsect1>
<title>Description</title>
<para><filename>systemd-remount-fs.service</filename> is an
early boot service that applies mount options listed in
<citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
to the root file system, the <filename>/usr</filename> file system,
and the kernel API file systems. This is required so that the
mount options of these file systems — which are pre-mounted by
the kernel, the initial RAM disk, container environments or system
manager code — are updated to those listed in
<filename>/etc/fstab</filename>. This service ignores normal file
systems and only changes the root file system (i.e.
<filename>/</filename>), <filename>/usr</filename> and the virtual
kernel API file systems such as <filename>/proc</filename>,
<filename>/sys</filename> or <filename>/dev</filename>. This
service executes no operation if <filename>/etc/fstab</filename>
does not exist or lists no entries for the mentioned file
systems.</para>
<para><filename>systemd-remount-fs.service</filename> is an early boot service that applies mount options
listed in <citerefentry
project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, or
gathered from the partition table (when
<citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
is active) to the root file system, the <filename>/usr</filename> file system, and the kernel API file
systems. This is required so that the mount options of these file systems — which are pre-mounted by the
kernel, the initial RAM disk, container environments or system manager code — are updated to those
configured in <filename>/etc/fstab</filename> and the other sources. This service ignores normal file
systems and only changes the root file system (i.e. <filename>/</filename>), <filename>/usr</filename>,
and the virtual kernel API file systems such as <filename>/proc</filename>, <filename>/sys</filename> or
<filename>/dev</filename>. This service executes no operation if no configuration is found
(<filename>/etc/fstab</filename> does not exist or lists no entries for the mentioned file systems, or
the partition table does not contain relevant entries).</para>
<para>For a longer discussion of kernel API file systems see
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API