X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-gpt-auto-generator.xml;h=17dee08ebbcea7c2b227dc4d9a7fabbc8fc58701;hp=95c0c35046c07175c5dcfde5063acecd306dabef;hb=79fbcd8869f5d2d0236f7272bf45ba6b3d4abbea;hpb=8410d73f06cbd80a6918dd2b6d90ef95bbd18de7

diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml
index 95c0c3504..17dee08eb 100644
--- a/man/systemd-gpt-auto-generator.xml
+++ b/man/systemd-gpt-auto-generator.xml
@@ -43,7 +43,8 @@
         <refnamediv>
                 <refname>systemd-gpt-auto-generator</refname>
                 <refpurpose>Generator for automatically discovering
-                and mounting <filename>/home</filename> as well as
+                and mounting root, <filename>/home</filename> and
+                <filename>/srv</filename> partitions, as well as
                 discovering and enabling swap partitions, based on GPT
                 partition type GUIDs.</refpurpose>
         </refnamediv>
@@ -56,38 +57,105 @@
                 <title>Description</title>
 
                 <para><filename>systemd-gpt-auto-generator</filename>
-                is a generator that automatically discovers
-                <filename>/home</filename> and swap partitions and
-                creates mount and swap units for them, based on the
-                the partition type GUIDs of GUID partition tables
-                (GPT). Note that this generator will execute no
-                operation on non-GPT systems, on systems where the
-                units are explicitly configured (for example, listed
-                in
-                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
-                or where the mount point is non-empty.</para>
-
-                <para>This generator will only look for partitions on
-                the same physical disk the root file system is stored
-                on. This generator has no effect on systems where the
-                root file system is distributed on multiple disks, for
-                example via btrfs RAID.</para>
-
-                <para>This generator is useful for centralizing file
-                system configuration in the partition table and making
-                manual configuration in
-                <filename>/etc/fstab</filename> or suchlike
+                is a unit generator that automatically discovers root,
+                <filename>/home</filename>, <filename>/srv</filename>
+                and swap partitions and creates mount and swap units
+                for them, based on the the partition type GUIDs of
+                GUID partition tables (GPT). It implements the <ulink
+                url="http://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable
+                Partitions Specification</ulink>. Note that this
+                generator has no effect on non-GPT systems, on systems
+                where the units are explicitly configured (for
+                example, listed in
+                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
+                or where the mount points are non-empty.</para>
+
+                <para>This generator will only look for root
+                partitions on the same physical disk the EFI System
+                Partition (ESP) is located on. It will only look for
+                the other partitions on the same physical disk the
+                root file system is located on. These partitions will
+                not be search on systems where the root file system is
+                distributed on multiple disks, for example via btrfs
+                RAID.</para>
+
+                <para><filename>systemd-gpt-auto-generator</filename>
+                is useful for centralizing file system configuration
+                in the partition table and making manual configuration
+                in <filename>/etc/fstab</filename> or suchlike
                 unnecessary.</para>
 
-                <para>This generator looks for swap partitions using
-                GPT type 0657fd6d-a4ab-43c4-84e50933c84b4f4f. It looks
-                for <filename>/home</filename> partitions using GPT
-                type 933ac7e1-2eb4-4f13-b8440e14e2aef915.</para>
+                <para>This generator looks for the partitions based on
+                their partition type GUID. The following partition
+                type GUIDs are identified:</para>
+
+                <table>
+                        <title>Partition Type GUIDs</title>
+                        <tgroup cols='3' align='left' colsep='1' rowsep='1'>
+                                <colspec colname="guid" />
+                                <colspec colname="name" />
+                                <colspec colname="explanation" />
+                                <thead>
+                                        <row>
+                                                <entry>Partition Type GUID</entry>
+                                                <entry>Name</entry>
+                                                <entry>Explanation</entry>
+                                        </row>
+                                </thead>
+                                <tbody>
+                                        <row>
+                                                <entry>44479540-f297-41b2-9af7-d131d5f0458a</entry>
+                                                <entry><filename>Root Partition (x86)</filename></entry>
+                                                <entry>On 32bit x86 systems the first x86 root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
+                                        </row>
+                                        <row>
+                                                <entry>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</entry>
+                                                <entry><filename>Root Partition (x86-64)</filename></entry>
+                                                <entry>On 64bit x86 systems the first x86-64 root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
+                                        </row>
+                                        <row>
+                                                <entry>933ac7e1-2eb4-4f13-b844-0e14e2aef915</entry>
+                                                <entry>Home Partition</entry>
+                                                <entry>The first home partition on the disk the root partition is located on is mounted to <filename>/home</filename>.</entry>
+                                        </row>
+                                        <row>
+                                                <entry>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</entry>
+                                                <entry>Server Data Partition</entry>
+                                                <entry>The first server data partition on the disk the root partition is located on is mounted to <filename>/srv</filename>.</entry>
+                                        </row>
+                                        <row>
+                                                <entry>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</entry>
+                                                <entry>Swap</entry>
+                                                <entry>All swap partitions located on the disk the root partition is located on are enabled.</entry>
+                                        </row>
+                                </tbody>
+                        </tgroup>
+                </table>
+
+                <para>The <filename>/home</filename> and
+                <filename>/srv</filename> partitions may be encrypted
+                in LUKS format. In this case a device mapper device is
+                set up under the names
+                <filename>/dev/mapper/home</filename> and
+                <filename>/dev/mapper/srv</filename>. Note that this
+                might create conflicts if the same partition is listed
+                in <filename>/etc/crypttab</filename> with a different
+                device mapper device name.</para>
+
+                <para>Also note that
+                <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                will mount the EFI System Partition (ESP) to
+                <filename>/boot</filename> if not otherwise mounted.</para>
+
+                <para>When using this generator in conjunction with
+                btrfs file systems make sure to set the correct
+                default subvolumes on them, using <command>btrfs
+                subvolume set-default</command>.</para>
 
                 <para><filename>systemd-gpt-auto-generator</filename>
                 implements the <ulink
-                url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
-                specification</ulink>.</para>
+                url="http://www.freedesktop.org/wiki/Software/systemd/Generators">Generator
+                Specification</ulink>.</para>
         </refsect1>
 
         <refsect1>
@@ -96,8 +164,12 @@
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>