[systemd-devel] [PATCH 05/10] doc: resolve missing/extraneous words or inappropriate forms

Jan Engelhardt jengelh at inai.de
Mon Feb 17 07:29:31 PST 2014


Issues fixed:
* missing words required by grammar
* duplicated or extraneous words
* inappropriate forms (e.g. singular/plural), and declinations
* orthographic misspellings
---
 man/busctl.xml                   |  2 +-
 man/journalctl.xml               |  2 +-
 man/journald.conf.xml            |  8 ++++----
 man/machine-info.xml             |  6 +++---
 man/pam_systemd.xml              |  2 +-
 man/sd_bus_creds_get_pid.xml     |  4 ++--
 man/sd_bus_error.xml             | 12 ++++++------
 man/sd_bus_open_user.xml         |  6 +++---
 man/sd_journal_print.xml         |  2 +-
 man/systemctl.xml                |  2 +-
 man/systemd-coredumpctl.xml      |  2 +-
 man/systemd-journald.service.xml |  4 ++--
 man/systemd-nspawn.xml           | 16 ++++++++--------
 man/systemd-system.conf.xml      |  4 ++--
 man/systemd-udevd.service.xml    |  4 ++--
 man/systemd.exec.xml             |  6 +++---
 man/systemd.journal-fields.xml   |  2 +-
 man/systemd.socket.xml           |  6 +++---
 man/udev.xml                     |  2 +-
 19 files changed, 46 insertions(+), 46 deletions(-)

diff --git a/man/busctl.xml b/man/busctl.xml
index 3fdef7b..ab18a49 100644
--- a/man/busctl.xml
+++ b/man/busctl.xml
@@ -171,7 +171,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <term><option>--activatable</option></term>
 
           <listitem><para>When showing the list of endpoints, show
-          only endpoints which haven't actually been activated yet,
+          only endpoints which have actually not been activated yet,
           but may be started automatically if accessed.</para>
           </listitem>
       </varlistentry>
diff --git a/man/journalctl.xml b/man/journalctl.xml
index 626d820..50027b4 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -380,7 +380,7 @@
                                                         terse output, only
                                                         showing the actual
                                                         message of each journal
-                                                        entry with no meta data,
+                                                        entry with no metadata,
                                                         not even a timestamp.
                                                         </para>
                                                 </listitem>
diff --git a/man/journald.conf.xml b/man/journald.conf.xml
index 03bcd0c..a814ec1 100644
--- a/man/journald.conf.xml
+++ b/man/journald.conf.xml
@@ -269,12 +269,12 @@
                                 violated when systemd-journald is
                                 started, the value will be raised to
                                 percentage that is actually free. This
-                                means that if before there was enough
-                                free space and journal files were
+                                means that if there was enough
+                                free space before and journal files were
                                 created, and subsequently something
                                 else causes the file system to fill
                                 up, journald will stop using more
-                                space, but it'll will not removing
+                                space, but it will not be removing
                                 existing files to go reduce footprint
                                 either.</para>
 
@@ -400,7 +400,7 @@
                                 and
                                 <literal>systemd.journald.forward_to_console=</literal>.
                                 When forwarding to the console, the
-                                TTY to log to log to can be changed
+                                TTY to log to can be changed
                                 with <varname>TTYPath=</varname>,
                                 described below.</para></listitem>
                         </varlistentry>
diff --git a/man/machine-info.xml b/man/machine-info.xml
index ddf8f8b..7448e68 100644
--- a/man/machine-info.xml
+++ b/man/machine-info.xml
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <para>The <filename>/etc/machine-info</filename> file
-                contains machine meta data.</para>
+                contains machine metadata.</para>
 
                 <para>The basic file format of
                 <filename>machine-info</filename> is a
@@ -68,7 +68,7 @@
                 execution engine.</para>
 
                 <para><filename>/etc/machine-info</filename> contains
-                meta data about the machine that is set by the user or
+                metadata about the machine that is set by the user or
                 administrator.</para>
 
                 <para>Depending on the operating system other
@@ -84,7 +84,7 @@
         <refsect1>
                 <title>Options</title>
 
-                <para>The following machine meta data parameters may
+                <para>The following machine metadata parameters may
                 be set using
                 <filename>/etc/machine-info</filename>:</para>
 
diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index 66d40fc..3022cdb 100644
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -227,7 +227,7 @@
 
                 <para>The following environment variables are read by
                 the module and may be used by the PAM service to pass
-                meta data to the module:</para>
+                metadata to the module:</para>
 
                 <variablelist class='environment-variables'>
                         <varlistentry>
diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml
index 740082e..25978a2 100644
--- a/man/sd_bus_creds_get_pid.xml
+++ b/man/sd_bus_creds_get_pid.xml
@@ -225,7 +225,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para>Those functions return information from an
+    <para>These functions return information from an
     <parameter>sd_bus_creds</parameter> object. It may be created with
     <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
     in which case it will describe the specified process, or it may be
@@ -311,7 +311,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_bus_creds_has_effective_cap</function> will
     check whether the capability specified by
     <parameter>capability</parameter> was set in the effective
-    capabilities mask. A positive return value means that is were
+    capabilities mask. A positive return value means that is was
     set, zero means that it was not set, and a negative return
     value signifies an error. See
     <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml
index 642b0b9..671df44 100644
--- a/man/sd_bus_error.xml
+++ b/man/sd_bus_error.xml
@@ -231,10 +231,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
   <refsect1>
     <title>Description</title>
 
-    <para><structname>sd_bus_error</structname> structure carries
+    <para>The <structname>sd_bus_error</structname> structure carries
     information for a <filename>sd-bus</filename> error.
     Functions described below can be used to set and query fields in
-    this structure. Field <structfield>name</structfield> contains a
+    this structure. The <structfield>name</structfield> field contains a
     short identifier of an error. It should follow the rules for error
     names described in the D-Bus specification, subsection <ulink
     url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names">Valid
@@ -251,16 +251,16 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     and the remaining ones to <constant>-ENXIO</constant>. Well-known
     D-Bus error names are available as constants
     <constant>SD_BUS_ERROR_FAILED</constant>, etc., listed above. If
-    <parameter>name</parameter> is <constant>NULL</constant>, it is is
+    <parameter>name</parameter> is <constant>NULL</constant>, it is
     assumed that no error occured, and 0 is returned. This means that
     this function may be conveniently used in a
     <function>return</function> statement.</para>
 
     <para>If <parameter>e</parameter> is not
     <constant>NULL</constant>, <structfield>name</structfield> and
-    <structfield>message</structfield> will be filled-in in the
+    <structfield>message</structfield> in the
     <structname>sd_bus_error</structname> structure
-    <parameter>e</parameter> points at. As described above,
+    <parameter>e</parameter> points at will be filled in. As described above,
     <parameter>name</parameter> may be <constant>NULL</constant>,
     which is treated as no error. Parameter
     <parameter>message</parameter> may also be
@@ -307,7 +307,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <parameter>e</parameter>. If the strings in
     <parameter>e</parameter> were set using
     <function>sd_bus_set_error_const</function>, they will be shared.
-    Otherwie, they wil be copied.</para>
+    Otherwise, they will be copied.</para>
 
     <para><function>sd_bus_error_is_set</function> will return
     <constant>true</constant> if <parameter>e</parameter> is
diff --git a/man/sd_bus_open_user.xml b/man/sd_bus_open_user.xml
index 0effee4..22a4f61 100644
--- a/man/sd_bus_open_user.xml
+++ b/man/sd_bus_open_user.xml
@@ -100,7 +100,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <function>sd_bus_open_system()</function> does the same, but
     connects to the system bus.</para>
 
-    <para>If <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment
+    <para>If the <varname>$DBUS_SESSION_BUS_ADDRESS</varname> environment
     variable is set
     (c.f. <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
     it will be used as the address of the user bus. This variable can
@@ -108,7 +108,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     this variable is not set, a suitable default for the default user
     D-Bus instance will be used.</para>
 
-    <para>If <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> environment
+    <para>If the <varname>$DBUS_SYSTEM_BUS_ADDRESS</varname> environment
     variable is set, it will be used as the address of the system
     bus. This variable uses the same syntax as
     <varname>$DBUS_SESSION_BUS_ADDRESS</varname>/. If this variable is
@@ -158,7 +158,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     </para>
 
-    <para>Functions <function>sd_bus_default_user()</function> and
+    <para>The functions <function>sd_bus_default_user()</function> and
     <function>sd_bus_default_system()</function> do not create a new
     reference.</para>
   </refsect1>
diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml
index 7b08733..6386577 100644
--- a/man/sd_journal_print.xml
+++ b/man/sd_journal_print.xml
@@ -203,7 +203,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid(
                 be guaranteed. Using
                 <function>sd_journal_print()</function> has the
                 benefit of logging source code line, filenames, and
-                functions as meta data along all entries, and
+                functions as metadata along all entries, and
                 guaranteeing chronological ordering with structured
                 log entries that are generated via
                 <function>sd_journal_send()</function>. Using
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 418e71f..d6d2c76 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -1444,7 +1444,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       <literal>[]</literal> may be used. See
       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
       for more details. The patterns are matched against the names of
-      currently loaded units, and patterns which don't match anything
+      currently loaded units, and patterns which do not match anything
       are silently skipped. For example:
       <programlisting># systemctl stop sshd@*.service</programlisting>
       will stop all <filename>sshd at .service</filename> instances.
diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml
index 286ff14..4318a2f 100644
--- a/man/systemd-coredumpctl.xml
+++ b/man/systemd-coredumpctl.xml
@@ -135,7 +135,7 @@
 
                                 <listitem><para>Extract the last coredump
                                 matching specified characteristics.
-                                Coredump will be written on standard output,
+                                The coredump will be written on standard output,
                                 unless an output file is specified with
                                 <option>-o/--output</option>.
                                 </para></listitem>
diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml
index 0a20e21..4d2cb40 100644
--- a/man/systemd-journald.service.xml
+++ b/man/systemd-journald.service.xml
@@ -66,10 +66,10 @@
                 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call, from standard input and standard error of system
                 services or via its native API. It will implicitly
-                collect numerous meta data fields for each log
+                collect numerous metadata fields for each log
                 messages in a secure and unfakeable way. See
                 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
-                for more information about the collected meta data.
+                for more information about the collected metadata.
                 </para>
 
                 <para>Log data collected by the journal is primarily
diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
index 5bddd89..b34d38c 100644
--- a/man/systemd-nspawn.xml
+++ b/man/systemd-nspawn.xml
@@ -179,8 +179,8 @@
 
                                 <listitem><para>Turns off any status
                                 output by the tool itself. When this
-                                switch is used, then the only output
-                                by nspawn will be the console output
+                                switch is used, the only output
+                                from nspawn will be the console output
                                 of the container OS itself.</para></listitem>
                         </varlistentry>
 
@@ -303,14 +303,14 @@
                                 <term><option>--network-veth</option></term>
 
                                 <listitem><para>Create a virtual
-                                ethernet link between host and
+                                Ethernet link between host and
                                 container. The host side of the
-                                ethernet link will be available as
+                                Ethernet link will be available as a
                                 network interface named after the
                                 container's name (as specified with
                                 <option>--machine=</option>), prefixed
                                 with <literal>ve-</literal>. The
-                                container side of the the ethernet
+                                container side of the the Ethernet
                                 link will be named
                                 <literal>host0</literal>. Note that
                                 <option>--network-veth</option>
@@ -322,7 +322,7 @@
                                 <term><option>--network-bridge=</option></term>
 
                                 <listitem><para>Adds the host side of the
-                                ethernet link created with
+                                Ethernet link created with
                                 <option>--network-veth</option>
                                 to the specified bridge. Note that
                                 <option>--network-bridge</option>
@@ -540,13 +540,13 @@
                                 container in, simply register the
                                 service or scope unit
                                 <command>systemd-nspawn</command> has
-                                been invoked in in
+                                been invoked in with
                                 <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. This
                                 has no effect if
                                 <option>--register=no</option> is
                                 used. This switch should be used if
                                 <command>systemd-nspawn</command> is
-                                invoked from within an a service unit,
+                                invoked from within a service unit,
                                 and the service unit's sole purpose
                                 is to run a single
                                 <command>systemd-nspawn</command>
diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml
index 6c1b1e7..f3a89ad 100644
--- a/man/systemd-system.conf.xml
+++ b/man/systemd-system.conf.xml
@@ -99,7 +99,7 @@
                                 <listitem><para>Configures the initial
                                 CPU affinity for the init
                                 process. Takes a space-separated list
-                                of CPU indexes.</para></listitem>
+                                of CPU indices.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -216,7 +216,7 @@
 
                                 <listitem><para>Takes a
                                 space-separated list of architecture
-                                identifiers. Selects of which
+                                identifiers. Selects from which
                                 architectures system calls may be
                                 invoked on this system. This may be
                                 used as an effective way to disable
diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml
index 0e49fa0..bb04694 100644
--- a/man/systemd-udevd.service.xml
+++ b/man/systemd-udevd.service.xml
@@ -83,7 +83,7 @@
         <term><option>--exec-delay=</option></term>
         <listitem>
           <para>Delay the execution of <varname>RUN</varname>
-          instruction by the given number of seconds. This option
+          instructions by the given number of seconds. This option
           might be useful when debugging system crashes during
           coldplug caused by loading non-working kernel
           modules.</para>
@@ -148,7 +148,7 @@
         <term><varname>udev.exec-delay=</varname></term>
         <term><varname>rd.udev.exec-delay=</varname></term>
         <listitem>
-          <para>Delay the execution of RUN instruction by the given
+          <para>Delay the execution of RUN instructions by the given
           number of seconds. This option might be useful when
           debugging system crashes during coldplug caused by loading
           non-working kernel modules.</para>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index c08feba..252992b 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -248,7 +248,7 @@
                                 <listitem><para>Controls the CPU
                                 affinity of the executed
                                 processes. Takes a space-separated
-                                list of CPU indexes. This option may
+                                list of CPU indices. This option may
                                 be specified more than once in which
                                 case the specificed CPU affinity masks
                                 are merged. If the empty string is
@@ -1041,14 +1041,14 @@
                                 add or delete the listed system calls
                                 from the set of the filtered system
                                 calls, depending of its type and the
-                                default action (e.g. You have started
+                                default action. (For example, if you have started
                                 with a whitelisting of
                                 <function>read</function> and
                                 <function>write</function>, and right
                                 after it add a blacklisting of
                                 <function>write</function>, then
                                 <function>write</function> will be
-                                removed from the set).
+                                removed from the set.)
                                 </para></listitem>
 
                                 <para>Note that setting
diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index c93b5da..d77e6eb 100644
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -529,7 +529,7 @@
                 JSON Format</ulink>, the addresses of journal entries
                 are serialized into fields prefixed with double
                 underscores. Note that these are not proper fields when
-                stored in the journal but for addressing meta data of
+                stored in the journal but for addressing metadata of
                 entries. They cannot be written as part of structured
                 log entries via calls such as
                 <citerefentry><refentrytitle>sd_journal_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>. They
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index f495fe3..5e9b39f 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -90,9 +90,9 @@
                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for more information about .service files). The name
                 of the .service unit is by default the same as the
-                name of the .socket unit, but can be altered with
+                name of the .socket unit, but can be altered with the
                 <option>Service=</option> option described below.
-                Depending on the setting of <option>Accept=</option>
+                Depending on the setting of the <option>Accept=</option>
                 option described below, this .service unit must either
                 be named like the .socket unit, but with the suffix
                 replaced, unless overridden with
@@ -135,7 +135,7 @@
                 <para>Socket units may be used to implement on-demand
                 starting of services, as well as parallelized starting
                 of services. See the blog stories linked at the end
-                for introduction.</para>
+                for an introduction.</para>
 
                 <para>Note that the daemon software configured for
                 socket activation with socket units needs to be able
diff --git a/man/udev.xml b/man/udev.xml
index 1bf0b08..da4ff22 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -874,7 +874,7 @@
           <listitem>
             <para>An ordered, space-separated list of policies by which the
               interface name should be set. <literal>NamePolicy</literal> may
-              be disabeld by specifying <literal>net.ifnames=0</literal> on the
+              be disabeled by specifying <literal>net.ifnames=0</literal> on the
               kernel commandline. Each of the policies may fail, and the first
               successfull one is used. The name is not set directly, but
               is exported to udev as the property <literal>ID_NET_NAME</literal>,
-- 
1.8.4.5



More information about the systemd-devel mailing list