]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: use <warning> for warnings
authorDavid Tardon <dtardon@redhat.com>
Sat, 23 Dec 2023 17:40:15 +0000 (18:40 +0100)
committerDavid Tardon <dtardon@redhat.com>
Mon, 25 Dec 2023 09:00:43 +0000 (10:00 +0100)
man/crypttab.xml
man/systemctl.xml
man/systemd-storagetm.service.xml
man/systemd.network.xml
man/udevadm.xml
man/veritytab.xml

index 5e67d44cb3a2093d07f13ef3fdbbf5e31dad8deb..175e169fbc71c5945c4031e5e66994f5841b98cf 100644 (file)
         <citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
         This option implies <option>plain</option>.</para>
 
-        <para>WARNING: Using the <option>swap</option> option will
-        destroy the contents of the named partition during every boot,
-        so make sure the underlying block device is specified
-        correctly.</para>
+        <warning>
+          <para>Using the <option>swap</option> option will
+          destroy the contents of the named partition during every boot,
+          so make sure the underlying block device is specified
+          correctly.</para>
+        </warning>
 
         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
       </varlistentry>
         <literal>btrfs</literal>. If no argument is specified defaults to <literal>ext4</literal>. This
         option implies <option>plain</option>.</para>
 
-        <para>WARNING: Using the <option>tmp</option> option will destroy the contents of the named partition
-        during every boot, so make sure the underlying block device is specified correctly.</para>
+        <warning>
+          <para>Using the <option>tmp</option> option will destroy the contents of the named partition
+          during every boot, so make sure the underlying block device is specified correctly.</para>
+        </warning>
 
         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
       </varlistentry>
index e0267df778391b7d02d8011868876bbc59a3178d..b22c1b19541c7cf7ffe98d86ef56f626ff369b82 100644 (file)
@@ -2478,11 +2478,15 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
           processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
           drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified
           twice for these operations (with the exception of <command>kexec</command>), they will be executed
-          immediately, without terminating any processes or unmounting any file systems. Warning: specifying
-          <option>--force</option> twice with any of these operations might result in data loss. Note that when
-          <option>--force</option> is specified twice the selected operation is executed by
-          <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
-          succeed even when the system manager has crashed.</para>
+          immediately, without terminating any processes or unmounting any file systems.</para>
+
+          <warning>
+            <para>Specifying
+            <option>--force</option> twice with any of these operations might result in data loss. Note that when
+            <option>--force</option> is specified twice the selected operation is executed by
+            <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
+            succeed even when the system manager has crashed.</para>
+          </warning>
         </listitem>
       </varlistentry>
 
index 0ca1cbd8a5c2d1a5c633920d015784341ed26193..728b3ae37a0b652a61e6f2a64977191790fa353b 100644 (file)
     NVMe-TCP mass storage devices. Its primary use-case is to be invoked by the
     <filename>storage-target-mode.target</filename> unit that can be booted into.</para>
 
-    <para>Warning: the NVMe disks are currently exposed without authentication or encryption, in read/write
-    mode. This means network peers may read from and write to the device without any restrictions. This
-    functionality should hence only be used in a local setup.</para>
+    <warning>
+      <para>The NVMe disks are currently exposed without authentication or encryption, in read/write
+      mode. This means network peers may read from and write to the device without any restrictions. This
+      functionality should hence only be used in a local setup.</para>
+    </warning>
 
     <para>Note that to function properly networking must be configured too. The recommended mechanism to boot
     into a storage target mode is by adding <literal>rd.systemd.unit=storage-target-mode.target
index ea558c4b4ef58bb8a436e6bee8269090a81cdb3e..1f30cc13b30b7e1796f8134c56856b41de0a5ec3 100644 (file)
@@ -1342,13 +1342,15 @@ Table=1234</programlisting></para>
           Fallback Peer Labeling</ulink> rules. They will be removed when the interface is
           deconfigured. Failures to manage the labels will be ignored.</para>
 
-          <para>Warning: Once labeling is enabled for network traffic, a lot of LSM access control points in
-          Linux networking stack go from dormant to active. Care should be taken to avoid getting into a
-          situation where for example remote connectivity is broken, when the security policy hasn't been
-          updated to consider LSM per-packet access controls and no rules would allow any network
-          traffic. Also note that additional configuration with <citerefentry
-          project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-          is needed.</para>
+          <warning>
+            <para>Once labeling is enabled for network traffic, a lot of LSM access control points in
+            Linux networking stack go from dormant to active. Care should be taken to avoid getting into a
+            situation where for example remote connectivity is broken, when the security policy hasn't been
+            updated to consider LSM per-packet access controls and no rules would allow any network
+            traffic. Also note that additional configuration with <citerefentry
+            project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+            is needed.</para>
+          </warning>
 
           <para>Example:
           <programlisting>[Address]
index a9a4a4c37490acaca7433bf33c349e5b558a747f..34f7f5c38748e44ae53b4dfdcce325d418ba2dc5 100644 (file)
             <para>Typically, it is essential that applications which intend to use such a match, make
             sure a suitable udev rule is installed that sets at least one property on devices that
             shall be matched. See also Initialized Devices section below for more details.</para>
-            <para>WARNING: <option>--initialized-nomatch</option> can potentially save a significant
-            amount of time compared to re-triggering all devices in the system and e.g. can be used to
-            optimize boot time. However, this is not safe to be used in a boot sequence in general.
-            Especially, when udev rules for a device depend on its parent devices (e.g.
-            <literal>ATTRS</literal> or <literal>IMPORT{parent}</literal> keys, see
-            <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
-            for more details), the final state of the device becomes easily unstable with this option.
-            </para>
+            <warning>
+              <para><option>--initialized-nomatch</option> can potentially save a significant
+              amount of time compared to re-triggering all devices in the system and e.g. can be used to
+              optimize boot time. However, this is not safe to be used in a boot sequence in general.
+              Especially, when udev rules for a device depend on its parent devices (e.g.
+              <literal>ATTRS</literal> or <literal>IMPORT{parent}</literal> keys, see
+              <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+              for more details), the final state of the device becomes easily unstable with this option.
+              </para>
+            </warning>
 
             <xi:include href="version-info.xml" xpointer="v251"/>
           </listitem>
index 5e444878bc8f692d272b78332a02fc4c0bfab971..ee88528775a56889cabf53b00e19c0e961ba06cb 100644 (file)
@@ -150,10 +150,11 @@ This is based on crypttab(5).
         <term><option>ignore-zero-blocks</option></term>
 
         <listitem><para>Instruct kernel to not verify blocks that are expected to contain zeroes and always directly
-        return zeroes instead.
+        return zeroes instead.</para>
 
-        WARNING: Use this option only in very specific cases. This option is available since Linux kernel version 4.5.
-        </para>
+        <warning>
+          <para>Use this option only in very specific cases. This option is available since Linux kernel version 4.5.</para>
+        </warning>
 
         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
       </varlistentry>
@@ -162,11 +163,12 @@ This is based on crypttab(5).
         <term><option>check-at-most-once</option></term>
 
         <listitem><para>Instruct kernel to verify blocks only the first time they are read from the data device, rather
-        than every time.
+        than every time.</para>
 
-        WARNING: It provides a reduced level of security because only offline tampering of the data device's content
-        will be detected, not online tampering. This option is available since Linux kernel version 4.17.
-        </para>
+        <warning>
+          <para>It provides a reduced level of security because only offline tampering of the data device's content
+          will be detected, not online tampering. This option is available since Linux kernel version 4.17.</para>
+        </warning>
 
         <xi:include href="version-info.xml" xpointer="v248"/></listitem>
       </varlistentry>