[systemd-devel] [PATCH 2/3] doc: typographical improvements and choice of words

[Jan Engelhardt]

---
 CODING_STYLE            | 10 +++++-----
 NEWS                    |  4 ++--
 man/sysctl.d.xml        |  4 ++--
 man/systemd.network.xml |  4 ++--
 man/tmpfiles.d.xml      |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/CODING_STYLE b/CODING_STYLE
index cb8d96c..e192944 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -41,11 +41,11 @@
 - Don't synchronously talk to any other service from PID 1, due to
   risk of deadlocks
 
-- Avoid fixed sized string buffers, unless you really know the maximum
+- Avoid fixed-size string buffers, unless you really know the maximum
   size and that maximum size is small. They are a source of errors,
-  since they possibly result in truncated strings. Often it is nicer
-  to use dynamic memory, alloca() or VLAs. If you do allocate fixed
-  size strings on the stack, then it's probably only OK if you either
+  since they possibly result in truncated strings. It is often nicer
+  to use dynamic memory, alloca() or VLAs. If you do allocate fixed-size
+  strings on the stack, then it's probably only OK if you either
   use a maximum size such as LINE_MAX, or count in detail the maximum
   size a string can have. (DECIMAL_STR_MAX and DECIMAL_STR_WIDTH
   macros are your friends for this!)
@@ -99,7 +99,7 @@
 
 - Unless you allocate an array, "double" is always the better choice
   than "float". Processors speak "double" natively anyway, so this is
-  no speed benefit, and on calls like printf() "float"s get upgraded
+  no speed benefit, and on calls like printf() "float"s get promoted
   to "double"s anyway, so there is no point.
 
 - Don't invoke functions when you allocate variables on the stack. Wrong:
diff --git a/NEWS b/NEWS
index 835611c..00727d1 100644
--- a/NEWS
+++ b/NEWS
@@ -20,7 +20,7 @@ CHANGES WITH 214:
           synthesize "change" events for the disk and all its partitions.
           This is now unconditionally enabled, and if it turns out to
           cause major problems, we might turn it on only for specific
-          devices, or might need to disable it entirely. Device-mapper
+          devices, or might need to disable it entirely. Device Mapper
           devices are excluded from this logic.
 
         * We temporarily dropped the "-l" switch for fsck invocations,
@@ -83,7 +83,7 @@ CHANGES WITH 214:
 
         * Socket units gained a new Symlinks= setting. It takes a list
           of symlinks to create to file system sockets or FIFOs
-          created by the specific unix sockets. This is useful to
+          created by the specific Unix sockets. This is useful to
           manage symlinks to socket nodes with the same life-cycle as
           the socket itself.
 
diff --git a/man/sysctl.d.xml b/man/sysctl.d.xml
index ed9e997..dd73f92 100644
--- a/man/sysctl.d.xml
+++ b/man/sysctl.d.xml
@@ -154,7 +154,7 @@
                 </example>
 
                 <example>
-                        <title>Disable packet filter on the bridge (method one)</title>
+                        <title>Disable packet filter on bridged packets (method one)</title>
                         <para><filename>/etc/udev/rules.d/99-bridge.conf</filename>:
                         </para>
 
@@ -171,7 +171,7 @@ net.bridge.bridge-nf-call-arptables = 0
                 </example>
 
                 <example>
-                        <title>Disable packet filter on the bridge (method two)</title>
+                        <title>Disable packet filter on bridged packets (method two)</title>
                         <para><filename>/etc/modules-load.d/bridge.conf</filename>:
                         </para>
 
diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 21f6d50..5bff4d9 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -237,14 +237,14 @@
                                                 interfaces and all
                                                 known network
                                                 configuration files to
-                                                avoid IP range
+                                                avoid address range
                                                 conflicts. The default
                                                 system-wide pool
                                                 consists of
                                                 192.168.0.0/16,
                                                 172.16.0.0/12 and
                                                 10.0.0.0/8 for IPv4,
-                                                and [fc00::] for
+                                                and fc00::/7 for
                                                 IPv6. This
                                                 functionality is
                                                 useful to manage a
diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 65716c3..81457c4 100644
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -433,7 +433,7 @@ r! /tmp/.X[0-9]*-lock</programlisting>
                         be removed from the new access mode too, and
                         if all write bits are removed, they will be
                         removed from the new access mode too. In
-                        addition, the sticky/suid/gid bit is removed unless
+                        addition, the sticky/SUID/SGID bit is removed unless
                         applied to a directory. This
                         functionality is particularly useful in
                         conjunction with <varname>Z</varname>.</para>
-- 
2.0.0