[systemd-devel] [PATCH 2/5] doc: typographical fine tuning

Jan Engelhardt jengelh at inai.de
Sat May 3 10:15:24 PDT 2014


---
 NEWS                                |  4 ++--
 README                              |  2 +-
 TODO                                |  2 +-
 man/sd_bus_path_encode.xml          |  2 +-
 man/systemd-gpt-auto-generator.xml  | 12 ++++++------
 man/systemd-networkd.service.xml    |  2 +-
 man/systemd-nspawn.xml              |  4 ++--
 man/systemd-update-utmp.service.xml |  2 +-
 man/systemd.exec.xml                |  6 +++---
 man/systemd.link.xml                | 14 +++++++-------
 man/systemd.network.xml             |  4 ++--
 11 files changed, 27 insertions(+), 27 deletions(-)

diff --git a/NEWS b/NEWS
index 5ca6c03..ac2cf41 100644
--- a/NEWS
+++ b/NEWS
@@ -44,7 +44,7 @@ CHANGES WITH 212:
           on a partition to ignore it during automatic discovery.
 
         * Two new GPT type UUIDs have been added for automatic root
-          partition discovery, for 32bit and 64bit ARM. This is not
+          partition discovery, for 32-bit and 64-bit ARM. This is not
           particularly useful for discovering the root directory on
           these architectures during bare-metal boots (since UEFI is
           not common there), but still very useful to allow booting of
@@ -769,7 +769,7 @@ CHANGES WITH 209:
 
         * systemd-nspawn gained a new --personality= switch for
           setting the kernel personality for the container. This is
-          useful when running a 32bit container on a 64bit host. A
+          useful when running a 32-bit container on a 64-bit host. A
           similar option Personality= is now also available in service
           units.
 
diff --git a/README b/README
index 795db89..ef8c620 100644
--- a/README
+++ b/README
@@ -97,7 +97,7 @@ REQUIREMENTS:
         If systemd is compiled with libseccomp support on
         architectures which do not use socketcall() and where seccomp
         is supported (this effectively means x86-64 and ARM, but
-        excludes 32bit x86!), then nspawn will now install a
+        excludes 32-bit x86!), then nspawn will now install a
         work-around seccomp filter that makes containers boot even
         with audit being enabled. This works correctly only on kernels
         3.14 and newer though. TL;DR: turn audit off, still.
diff --git a/TODO b/TODO
index 876b6c8..c252145 100644
--- a/TODO
+++ b/TODO
@@ -565,7 +565,7 @@ Features:
 
 * support crash reporting operation modes (https://live.gnome.org/GnomeOS/Design/Whiteboards/ProblemReporting)
 
-* default to actual 32bit PIDs, via /proc/sys/kernel/pid_max
+* default to actual 32-bit PIDs, via /proc/sys/kernel/pid_max
 
 * be able to specify a forced restart of service A where service B depends on, in case B
   needs to be auto-respawned?
diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml
index 2cc720f..7cb8e77 100644
--- a/man/sd_bus_path_encode.xml
+++ b/man/sd_bus_path_encode.xml
@@ -91,7 +91,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     reversed with <function>sd_bus_decode()</function>. It is
     recommended to only use external identifiers here that generally
     require little escaping to be turned into valid bus path
-    identifiers (for example by sticking to a 7bit ASCII character
+    identifiers (for example by sticking to a 7-bit ASCII character
     set), in order to ensure the resulting bus path is still short and
     easily processed.</para>
 
diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml
index db98582..32e1183 100644
--- a/man/systemd-gpt-auto-generator.xml
+++ b/man/systemd-gpt-auto-generator.xml
@@ -106,22 +106,22 @@
                                         <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>
+                                                <entry>On 32-bit 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>
+                                                <entry>On 64-bit 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>69dad710-2ce4-4e3c-b16c-21a1d49abed3</entry>
-                                                <entry><filename>Root Partition (32bit ARM)</filename></entry>
-                                                <entry>On 32bit ARM systems the first ARM root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
+                                                <entry><filename>Root Partition (32-bit ARM)</filename></entry>
+                                                <entry>On 32-bit ARM systems the first ARM root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
                                         </row>
                                         <row>
                                                 <entry>b921b045-1df0-41c3-af44-4c6f280d3fae</entry>
-                                                <entry><filename>Root Partition (64bit ARM)</filename></entry>
-                                                <entry>On 64bit ARM systems the first ARM root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
+                                                <entry><filename>Root Partition (64-bit ARM)</filename></entry>
+                                                <entry>On 64-bit ARM systems the first ARM 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>
diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml
index 85fa2a4..75ea1a4 100644
--- a/man/systemd-networkd.service.xml
+++ b/man/systemd-networkd.service.xml
@@ -68,7 +68,7 @@
                 <para>Network configurations applied before networkd is started
                 are not removed, and static configuration applied by networkd
                 is not removed when networkd exits. Dynamic configuration applied by
-                networkd may also optionally be left in place on shut-down. This ensures
+                networkd may also optionally be left in place on shutdown. This ensures
                 restarting networkd does not cut the network connection, and, in particular,
                 that it is safe to transition between the initrd and the real root,
                 and back.</para>
diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
index 648a8cd..1894616 100644
--- a/man/systemd-nspawn.xml
+++ b/man/systemd-nspawn.xml
@@ -221,7 +221,7 @@
 
                                 <listitem><para>After transitioning
                                 into the container, change to the
-                                specified user defined in the
+                                specified user-defined in the
                                 container's user database. Like all
                                 other systemd-nspawn features, this is
                                 not a security feature and provides
@@ -600,7 +600,7 @@
                                 <literal>x86</literal> and
                                 <literal>x86-64</literal> are
                                 supported. This is useful when running
-                                a 32bit container on a 64bit
+                                a 32-bit container on a 64-bit
                                 host. If this setting is not used
                                 the personality reported in the
                                 container is the same as the one
diff --git a/man/systemd-update-utmp.service.xml b/man/systemd-update-utmp.service.xml
index 846fc95..0b316b1 100644
--- a/man/systemd-update-utmp.service.xml
+++ b/man/systemd-update-utmp.service.xml
@@ -61,7 +61,7 @@
                 is a service that writes SysV runlevel changes to utmp
                 and wtmp, as well as the audit logs, as they
                 occur. <filename>systemd-update-utmp.service</filename>
-                does the same for system reboots and shut-down requests.</para>
+                does the same for system reboots and shutdown requests.</para>
         </refsect1>
 
         <refsect1>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index 5d39bd1..d206d4f 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -1204,7 +1204,7 @@
                                 (which creates connected AF_UNIX
                                 sockets only) are unaffected. Note
                                 that this option has no effect on
-                                32bit x86 and is ignored (but works
+                                32-bit x86 and is ignored (but works
                                 correctly on x86-64). If running in user
                                 mode and this option is used,
                                 <varname>NoNewPrivileges=yes</varname>
@@ -1239,8 +1239,8 @@
                                 processes. Takes one of
                                 <constant>x86</constant> and
                                 <constant>x86-64</constant>. This is
-                                useful when running 32bit services on
-                                a 64bit host system. If not specified
+                                useful when running 32-bit services on
+                                a 64-bit host system. If not specified
                                 the personality is left unmodified and
                                 thus reflects the personality of the
                                 host system's
diff --git a/man/systemd.link.xml b/man/systemd.link.xml
index 3ad006e..2f5de23 100644
--- a/man/systemd.link.xml
+++ b/man/systemd.link.xml
@@ -236,8 +236,8 @@
                                                         <listitem>
                                                                 <para>The name is set based on entries in
                                                                 the udev's Hardware Database with the key
-                                                                <literal>ID_NET_NAME_FROM_DATABASE</literal>
-                                                                .</para>
+                                                                <literal>ID_NET_NAME_FROM_DATABASE</literal>.
+                                                                </para>
                                                         </listitem>
                                                 </varlistentry>
                                                 <varlistentry>
@@ -245,8 +245,8 @@
                                                         <listitem>
                                                                 <para>The name is set based on information given by
                                                                 the firmware for on-board devices, as exported by
-                                                                the udev property <literal>ID_NET_NAME_ONBOARD</literal>
-                                                                .</para>
+                                                                the udev property <literal>ID_NET_NAME_ONBOARD</literal>.
+                                                                </para>
                                                         </listitem>
                                                 </varlistentry>
                                                 <varlistentry>
@@ -254,8 +254,8 @@
                                                         <listitem>
                                                                 <para>The name is set based on information given by
                                                                 the firmware for hot-plug devices, as exported by
-                                                                the udev property <literal>ID_NET_NAME_SLOT</literal>
-                                                                .</para>
+                                                                the udev property <literal>ID_NET_NAME_SLOT</literal>.
+                                                                </para>
                                                         </listitem>
                                                 </varlistentry>
                                                 <varlistentry>
@@ -329,7 +329,7 @@
                                                 <varlistentry>
                                                         <term><literal>magic</literal></term>
                                                         <listitem>
-                                                                <para>Wake on receipt of a magic packet
+                                                                <para>Wake on receipt of a magic packet.
                                                                 </para>
                                                         </listitem>
                                                 </varlistentry>
diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 48e33ac..c4e5055 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -272,8 +272,8 @@
                                         <term><varname>Broadcast=</varname></term>
                                         <listitem>
                                                 <para>The broadcast address, which must be in the format described in
-                                                <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-                                                . This key only applies to IPv4 addresses. If it is not given, it is
+                                                <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+                                                This key only applies to IPv4 addresses. If it is not given, it is
                                                 derived from the <literal>Address</literal> key.</para>
                                         </listitem>
                                 </varlistentry>
-- 
1.8.4.5



More information about the systemd-devel mailing list