From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 10 May 2021 17:03:49 +0000 (+0200)
Subject: bootctl: extend --make-machine-id-directory= documentation a bit
X-Git-Tag: v249-rc1~250
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7eea910d240e58b83b28f106cebb545e898543b5;p=thirdparty%2Fsystemd.git

bootctl: extend --make-machine-id-directory= documentation a bit

The directory might not be created in the ESP but in the extended boot
loader partition, hence don#t claim otherwise.

Also, give a brief reason why the concept exists at all.

Link up machine-id man page.

Follow-up for: 6a3fff75baad94d9ebff1a6c7d1fb35448c44a81
---

diff --git a/man/bootctl.xml b/man/bootctl.xml
index 5dfed110ddd..5f5f137f8a8 100644
--- a/man/bootctl.xml
+++ b/man/bootctl.xml
@@ -239,15 +239,25 @@
 
       <varlistentry>
         <term><option>--make-machine-id-directory=yes|no|auto</option></term>
-        <listitem><para>Control creation and deletion of <literal>$ESP/$MACHINE_ID</literal> during
-        <option>install</option> and <option>remove</option>, respectively.
-        <literal>auto</literal> is equivalent to to <literal>yes</literal> if <literal>/etc/machine-id</literal>
-        resides on a filesystem other than tmpfs and <literal>no</literal> otherwise.
-        Defaults to <literal>auto</literal>.</para>
-
-        <para>Overriding this may be desired to hide the machine ID from the (unencrypted) ESP,
-        configure a <citerefentry><refentrytitle>kernel-install</refentrytitle><manvolnum>8</manvolnum></citerefentry> script, or,
-        conversely, commit a machine-id that only appears transient.</para></listitem>
+        <listitem><para>Control creation and deletion of the top-level machine ID directory on the file
+        system containing boot loader entries (i.e. beneath the file system returned by
+        <command>--print-boot-path</command> above) during <option>install</option> and
+        <option>remove</option>, respectively.  <literal>auto</literal> is equivalent to
+        <literal>yes</literal> if <filename>/etc/machine-id</filename> resides on a filesystem other than
+        tmpfs and <literal>no</literal> otherwise (in the latter case the machine ID is likely transient and
+        hence should not be used persistently in the ESP). Defaults to <literal>auto</literal>. See
+        <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
+        details about the machine ID concept and file.</para>
+
+        <para>Overriding this may be desirable to hide the machine ID from the (unencrypted) ESP, configure a
+        <citerefentry><refentrytitle>kernel-install</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        script, or, conversely, commit a transient machine ID.</para>
+
+        <para>The top-level machine ID directory is useful to allow smooth multi-boot installations: each
+        installed OS instance will have a different machine ID and thus a separate directory to place its
+        boot-time resources in. If this feature is turned off with this option, care needs to be taken that
+        multiple OS instances do not place conflicting files on the shared ESP and Extended Boot Loader
+        Partitions, or that multiple OS instances are not possible.</para></listitem>
       </varlistentry>
 
       <xi:include href="standard-options.xml" xpointer="no-pager"/>