]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man/networkctl,systemd-soft-reboot: capitalize and add periods
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 6 Nov 2023 14:02:20 +0000 (15:02 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 6 Nov 2023 19:16:34 +0000 (20:16 +0100)
We added version information, so now each bullet point contains multiple
paragraphs, so we need proper sentences.

man/networkctl.xml
man/systemd-soft-reboot.service.xml

index c5fb57499054e8961366d6353d22a78cab7f2569..68b1d97f09cf6d4e692c504a8c0c3a1cad8509f8 100644 (file)
@@ -72,7 +72,7 @@
               <varlistentry>
                 <term>missing</term>
                 <listitem>
-                    <para>the device is missing</para>
+                    <para>The device is missing.</para>
 
                     <xi:include href="version-info.xml" xpointer="v245"/>
                 </listitem>
@@ -80,7 +80,7 @@
               <varlistentry>
                 <term>off</term>
                 <listitem>
-                  <para>the device is powered down</para>
+                  <para>The device is powered down.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
@@ -88,7 +88,7 @@
               <varlistentry>
                 <term>no-carrier</term>
                 <listitem>
-                  <para>the device is powered up, but it does not yet have a carrier</para>
+                  <para>The device is powered up, but does not yet have a carrier.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
@@ -96,7 +96,7 @@
               <varlistentry>
                 <term>dormant</term>
                 <listitem>
-                  <para>the device has a carrier, but is not yet ready for normal traffic</para>
+                  <para>The device has a carrier, but is not yet ready for normal traffic.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>degraded-carrier</term>
                 <listitem>
-                  <para>one of the bonding or bridge slave network interfaces is in off, no-carrier, or dormant state, and the master interface has no address.</para>
+                  <para>One of the bonding or bridge slave network interfaces is in off, no-carrier, or
+                  dormant state, and the master interface has no address.</para>
 
                   <xi:include href="version-info.xml" xpointer="v242"/>
                 </listitem>
               <varlistentry>
                 <term>carrier</term>
                 <listitem>
-                  <para>the link has a carrier, or for bond or bridge master, all bonding or bridge slave
-                  network interfaces are enslaved to the master</para>
+                  <para>The link has carrier, or for bond or bridge master, all bonding or bridge slave
+                  network interfaces are enslaved to the master.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>degraded</term>
                 <listitem>
-                  <para>the link has carrier and addresses valid on the local link configured. For bond or
+                  <para>The link has carrier and addresses valid on the local link configured. For bond or
                   bridge master this means that not all slave network interfaces have carrier but at least
                   one does.</para>
 
               <varlistentry>
                 <term>enslaved</term>
                 <listitem>
-                  <para>the link has carrier and is enslaved to bond or bridge master network interface</para>
+                  <para>The link has carrier and is enslaved to bond or bridge master network interface.
+                  </para>
 
                   <xi:include href="version-info.xml" xpointer="v242"/>
                 </listitem>
               <varlistentry>
                 <term>routable</term>
                 <listitem>
-                  <para>the link has carrier and routable address configured. For bond or bridge master it is
+                  <para>The link has carrier and routable address configured. For bond or bridge master it is
                   not necessary for all slave network interfaces to have carrier, but at least one must.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
               <varlistentry>
                 <term>pending</term>
                 <listitem>
-                  <para>udev is still processing the link, we don't yet know if we will manage it</para>
+                  <para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                  is still processing the link, we don't yet know if we will manage it.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>initialized</term>
                 <listitem>
-                  <para>udev has processed the link, but we don't yet know if we will manage it</para>
+                  <para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                  has processed the link, but we don't yet know if we will manage it.</para>
 
                   <xi:include href="version-info.xml" xpointer="v251"/>
                 </listitem>
               <varlistentry>
                 <term>configuring</term>
                 <listitem>
-                  <para>in the process of retrieving configuration or configuring the link</para>
+                  <para>Configuration for the link is being retrieved or the link is being configured.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>configured</term>
                 <listitem>
-                  <para>link configured successfully</para>
+                  <para>Link has been configured successfully.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>unmanaged</term>
                 <listitem>
-                  <para>networkd is not handling the link</para>
+                  <para><command>systemd-networkd</command> is not handling the link.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>failed</term>
                 <listitem>
-                  <para>networkd failed to manage the link</para>
+                  <para><command>systemd-networkd</command> failed to configure the link.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
               <varlistentry>
                 <term>linger</term>
                 <listitem>
-                  <para>the link is gone, but has not yet been dropped by networkd</para>
+                  <para>The link is gone, but has not yet been dropped by <command>systemd-networkd</command>.</para>
 
                   <xi:include href="version-info.xml" xpointer="v240"/>
                 </listitem>
             <varlistentry>
               <term>unknown</term>
               <listitem>
-                <para>all links have unknown online status (i.e. there are no required links)</para>
+                <para>All links have unknown online status (i.e. there are no required links).</para>
 
                 <xi:include href="version-info.xml" xpointer="v249"/>
               </listitem>
             <varlistentry>
               <term>offline</term>
               <listitem>
-                <para>all required links are offline</para>
+                <para>All required links are offline.</para>
 
                 <xi:include href="version-info.xml" xpointer="v249"/>
               </listitem>
             <varlistentry>
               <term>partial</term>
               <listitem>
-                <para>some, but not all, required links are online</para>
+                <para>Some, but not all, required links are online.</para>
 
                 <xi:include href="version-info.xml" xpointer="v249"/>
               </listitem>
             <varlistentry>
               <term>online</term>
               <listitem>
-                <para>all required links are online</para>
+                <para>All required links are online.</para>
 
                 <xi:include href="version-info.xml" xpointer="v249"/>
               </listitem>
index c232df41a16d67329e1379fcb88cdda0ac79c027..8884c24774240b5dbc178675e3ab09151ff9a9e5 100644 (file)
       <listitem><para>The second phase of regular shutdown, as implemented by
       <citerefentry><refentrytitle>systemd-shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
 
-      <listitem><para>The third phase of regular shutdown, i.e. the return to the initrd
-      context</para></listitem>
+      <listitem><para>The third phase of regular shutdown, i.e. the return to the initrd context.
+      </para></listitem>
 
-      <listitem><para>The hardware reboot operation</para></listitem>
+      <listitem><para>The hardware reboot operation.</para></listitem>
 
-      <listitem><para>The firmware initialization</para></listitem>
+      <listitem><para>The firmware initialization.</para></listitem>
 
-      <listitem><para>The boot loader initialization</para></listitem>
+      <listitem><para>The boot loader initialization.</para></listitem>
 
-      <listitem><para>The kernel initialization</para></listitem>
+      <listitem><para>The kernel initialization.</para></listitem>
 
-      <listitem><para>The initrd initialization</para></listitem>
+      <listitem><para>The initrd initialization.</para></listitem>
     </itemizedlist>
 
     <para>However this form of reboot comes with drawbacks as well:</para>