man: use <simplelist> for 'See also' sections

[thirdparty/systemd.git] / man / integritytab.xml

diff --git a/man/integritytab.xml b/man/integritytab.xml
index c2ad2573a0cd5dfec2879de2739a8837e2edcaeb..ebffeeb25e7bfced9afb64ef41d8a2284e5a976d 100644 (file)
--- a/man/integritytab.xml
+++ b/man/integritytab.xml
@@ -50,7 +50,7 @@
     <literal>UUID=</literal> followed by the UUID,
     <literal>PARTUUID=</literal> followed by the partition UUID,
     <literal>LABEL=</literal> followed by the label,
-    <literal>PARTLABEL=</literal> followed by the partition label,
+    <literal>PARTLABEL=</literal> followed by the partition label.
     </para>
 
     <para>The third field if present contains an absolute filename path to a key file or a <literal>-</literal>
@@ -69,7 +69,25 @@
         <listitem><para>
         Allow the use of discard (TRIM) requests for the device.
         This option is available since the Linux kernel version 5.7.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>mode=(journal|bitmap|direct)</option></term>
+
+        <listitem><para>
+        Enable journaled, bitmapped or direct (passthrough) mode. Journaled mode is the default when this option is not specified.
+        It provides safety against crashes, but can be slow because all data has to be written twice.
+        Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it may not be detected.
+        Direct mode disables the journal and the bitmap. Corresponds to the "direct writes" mode documented in
+        <ulink url="https://docs.kernel.org/admin-guide/device-mapper/dm-integrity.html">the dm-integrity documentation</ulink>.
+        Note that without a journal, if there is a crash, it is possible that the integrity tags and data will not match. If used, the journal-*
+        options below will have no effect if passed.
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v254"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -78,7 +96,9 @@
         <listitem><para>
         Journal watermark in percent. When the journal percentage exceeds this watermark, the journal flush will be started.  Setting a value of
         "0%" uses default value.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -87,7 +107,9 @@
         <listitem><para>
         Commit time in milliseconds. When this time passes (and no explicit flush operation was issued), the journal is written.  Setting a value of
         zero uses default value.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -97,7 +119,9 @@
         Specify a separate block device that contains existing data. The second field specified in the
         integritytab for block device then will contain calculated integrity tags and journal for data-device,
         but not the end user data.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -105,7 +129,9 @@
 
         <listitem><para>
         The algorithm used for integrity checking.  The default is crc32c. Must match option used during format.
-        </para></listitem>
+        </para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
       </varlistentry>
     </variablelist>
 
@@ -150,12 +176,12 @@ data PARTUUID=5d4b1808-be76-774d-88af-03c4c3a41761 - allow-discards
 
   <refsect1>
     <title>See Also</title>
-    <para>
-      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-      <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-    </para>
+    <para><simplelist type="inline">
+      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+      <member><citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+      <member><citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+      <member><citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+    </simplelist></para>
   </refsect1>
 
 </refentry>