[systemd-devel] [PATCH] man: wording and grammar updates

Jan Engelhardt jengelh at inai.de
Sat Jul 20 21:53:14 PDT 2013


This includes regularly-submitted corrections to comma setting and
orthographical mishaps that appeared in man/ in recent commits.
---
 man/crypttab.xml                 |  4 ++--
 man/journalctl.xml               |  2 +-
 man/machinectl.xml               |  2 +-
 man/pam_systemd.xml              | 12 ++++++------
 man/systemctl.xml                | 10 +++++-----
 man/systemd-bootchart.xml        |  2 +-
 man/systemd-machined.service.xml |  2 +-
 man/systemd-run.xml              |  2 +-
 man/systemd.cgroup.xml           |  4 ++--
 man/systemd.scope.xml            |  2 +-
 man/systemd.slice.xml            |  6 +++---
 man/systemd.special.xml          |  6 +++---
 man/systemd.unit.xml             |  2 +-
 man/systemd.xml                  | 14 +++++++-------
 man/udev.xml                     |  2 +-
 15 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/man/crypttab.xml b/man/crypttab.xml
index 298f39e..5aade57 100644
--- a/man/crypttab.xml
+++ b/man/crypttab.xml
@@ -167,7 +167,7 @@
                                 <term><varname>luks</varname></term>
 
                                 <listitem><para>Force LUKS mode. When this mode
-                                is used the following options are ignored since
+                                is used, the following options are ignored since
                                 they are provided by the LUKS header on the
                                 device: <varname>cipher=</varname>,
                                 <varname>hash=</varname>,
@@ -232,7 +232,7 @@
                                 <term><varname>tcrypt</varname></term>
 
                                 <listitem><para>Use TrueCrypt encryption mode.
-                                When this mode is used the following options are
+                                When this mode is used, the following options are
                                 ignored since they are provided by the TrueCrypt
                                 header on the device or do not apply:
                                 <varname>cipher=</varname>,
diff --git a/man/journalctl.xml b/man/journalctl.xml
index c8559a0..dcc6d5d 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -269,7 +269,7 @@
                                                         <option>short-iso</option>
                                                 </term>
                                                 <listitem>
-                                                        <para>is very similar
+                                                        <para>is very similar,
                                                         but shows ISO 8601
                                                         wallclock timestamps.
                                                         </para>
diff --git a/man/machinectl.xml b/man/machinectl.xml
index 37fefea..5efa3a5 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -156,7 +156,7 @@
                                 <term><option>--signal=</option></term>
 
                                 <listitem><para>When used with
-                                <command>kill-machine</command> choose
+                                <command>kill-machine</command>, choose
                                 which signal to send to selected
                                 processes. Must be one of the
                                 well-known signal specifiers, such as
diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index 1d924bc..951ae20 100644
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -82,11 +82,11 @@
 
                         <listitem><para>A new systemd scope unit is
                         created for the session. If this is the first
-                        concurrent session of the user an implicit
+                        concurrent session of the user, an implicit
                         slice below <filename>user.slice</filename> is
                         automatically created and the scope placed in
                         it. In instance of the system service
-                        <filename>user at .service</filename> which runt
+                        <filename>user at .service</filename> which runs
                         the systemd user manager
                         instance.</para></listitem>
                 </orderedlist>
@@ -94,15 +94,15 @@
                 <para>On logout, this module ensures the following:</para>
 
                 <orderedlist>
-                        <listitem><para>If this is enabled all
+                        <listitem><para>If this is enabled, all
                         processes of the session are terminated. If
-                        the last concurrent session of a user ends his
+                        the last concurrent session of a user ends, his
                         user systemd instance will be terminated too,
                         and so will the user's slice
                         unit.</para></listitem>
 
-                        <listitem><para>If the las concurrent session
-                        of a user ends the
+                        <listitem><para>If the last concurrent session
+                        of a user ends, the
                         <varname>$XDG_RUNTIME_DIR</varname> directory
                         and all its contents are removed,
                         too.</para></listitem>
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 4bfce95..ee13a70 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -111,8 +111,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--state=</option></term>
 
         <listitem>
-        <para>Argument should be a comma-separated list of unit LOAD
-        or SUB or ACTIVE states. When listing units show only those
+        <para>The argument should be a comma-separated list of unit LOAD
+        or SUB or ACTIVE states. When listing units, show only those
         with specified LOAD or SUB or ACTIVE state.</para>
         </listitem>
       </varlistentry>
@@ -433,7 +433,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           is lost on reboot, the changes are lost too.</para>
 
           <para>Similar, when used with
-          <command>set-property</command> make changes only
+          <command>set-property</command>, make changes only
           temporarily, so that they are lost on the next
           reboot.</para>
         </listitem>
@@ -727,7 +727,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
           may. The changes are applied instantly, and stored on disk
           for future boots, unless <option>--runtime</option> is
-          passed in which case the settings only apply until the next
+          passed, in which case the settings only apply until the next
           reboot. The syntax of the property assignment follows
           closely the syntax of assignments in unit files.</para>
 
@@ -736,7 +736,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <para>Note that this command allows changing multiple
           properties at the same time, which is preferable over
           setting them individually. Like unit file configuration
-          settings assigning the empty list to list parameters will
+          settings, assigning the empty list to list parameters will
           reset the list.</para>
         </listitem>
       </varlistentry>
diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml
index 8de4c69..ae432b5 100644
--- a/man/systemd-bootchart.xml
+++ b/man/systemd-bootchart.xml
@@ -203,7 +203,7 @@
                         <varlistentry>
                                 <term><option>-o</option></term>
                                 <term><option>--output <replaceable>path</replaceable></option></term>
-                                <listitem><para>Specify the output folder for the
+                                <listitem><para>Specify the output directory for the
                                 graphs. By default, bootchart writes the graphs to
                                 <filename>/run/log</filename>.</para></listitem>
                         </varlistentry>
diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml
index 525944b..abe221a 100644
--- a/man/systemd-machined.service.xml
+++ b/man/systemd-machined.service.xml
@@ -63,7 +63,7 @@
 
                 <para>See
                 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                for some examples how to start a container the systemd
+                for some examples on how to start a container the systemd
                 way.</para>
 
                 <para>See the <ulink
diff --git a/man/systemd-run.xml b/man/systemd-run.xml
index 98ee476..3f777b5 100644
--- a/man/systemd-run.xml
+++ b/man/systemd-run.xml
@@ -151,7 +151,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <para>All command-line arguments after the first non-option
     argument become part of the commandline of the launched
-    process. If a command is run as service unit its first argument
+    process. If a command is run as service unit, its first argument
     needs to be an absolute binary path.</para>
   </refsect1>
 
diff --git a/man/systemd.cgroup.xml b/man/systemd.cgroup.xml
index 12b19f5..cc0eb15 100644
--- a/man/systemd.cgroup.xml
+++ b/man/systemd.cgroup.xml
@@ -322,9 +322,9 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           hierarchy of slices each of which might have resource
           settings applied.</para>
 
-          <para>For units of type slice the only accepted value for
+          <para>For units of type slice, the only accepted value for
           this setting is the parent slice. Since the name of a slice
-          unit implies the parent slice it is hence redundant to ever
+          unit implies the parent slice, it is hence redundant to ever
           set this parameter directly for slice units.</para>
         </listitem>
       </varlistentry>
diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml
index ff41c92..e8fa1ae 100644
--- a/man/systemd.scope.xml
+++ b/man/systemd.scope.xml
@@ -58,7 +58,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     but are only created programmatically using the bus interfaces of
     systemd. They are named similar to filenames. A unit whose name
     ends in <literal>.scope</literal> refers to a scope unit. Scopes
-    units manage a set of system processes. Unlike service units scope
+    units manage a set of system processes. Unlike service units, scope
     units manage externally created processes, and do not fork off
     processes on its own.</para>
 
diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml
index 7ddef85..b7b0622 100644
--- a/man/systemd.slice.xml
+++ b/man/systemd.slice.xml
@@ -60,10 +60,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     processes. This management is performed by creating a node in the
     control group tree. Units that manage processes (primarilly scope
     and service units) may be assigned to a specific slice. For each
-    slice certain resource limits may the be set, that apply to all
+    slice, certain resource limits may the be set that apply to all
     processes of all units contained in that slice. Slices are
     organized hierarchially in a tree. The name of the slice encodes
-    the location in the tree. The name consists of a "-" separated
+    the location in the tree. The name consists of a dash-separated
     series of names, which describes the path to the slice from the
     root slice. The root slice is named,
     <filename>-.slice</filename>. Example:
@@ -72,7 +72,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     the root slice <filename>-.slice</filename>.
     </para>
 
-    <para>By default service and scope units are placed in
+    <para>By default, service and scope units are placed in
     <filename>system.slice</filename>, virtual machines and containers
     registered with
     <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>1</manvolnum></citerefentry>
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 6d456e1..e1299ab 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -1050,7 +1050,7 @@
                         <varlistentry>
                                 <term><filename>system.slice</filename></term>
                                 <listitem>
-                                        <para>By default all services
+                                        <para>By default, all services
                                         services started by
                                         <command>systemd</command> are
                                         found in this slice.</para>
@@ -1060,7 +1060,7 @@
                         <varlistentry>
                                 <term><filename>user.slice</filename></term>
                                 <listitem>
-                                        <para>By default all user
+                                        <para>By default, all user
                                         processes and services started
                                         on behalf of the user,
                                         including the per-user systemd
@@ -1072,7 +1072,7 @@
                         <varlistentry>
                                 <term><filename>machine.slice</filename></term>
                                 <listitem>
-                                        <para>By defalt all virtual
+                                        <para>By defalt, all virtual
                                         machines and containers
                                         registered with
                                         <command>systemd-machined</command>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 65ba545..f6a0791 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -1119,7 +1119,7 @@
                                 <listitem><para>A symbolic link is
                                 created in the
                                 <filename>.wants/</filename> or
-                                <filename>.requires/</filename> folder
+                                <filename>.requires/</filename> directory
                                 of the listed unit when this unit is
                                 activated by <command>systemctl
                                 enable</command>.  This has the effect
diff --git a/man/systemd.xml b/man/systemd.xml
index 06d2ecf..1e54eac 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -294,18 +294,18 @@
                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                 however some are created automatically from other
                 configuration, dynamically from system state or
-                programmatically at runtime. Units may be 'active'
-                (meaning started, bound, plugged in, ...  depending on
-                the unit type, see below), or 'inactive' (meaning
+                programmatically at runtime. Units may be "active"
+                (meaning started, bound, plugged in, ..., depending on
+                the unit type, see below), or "inactive" (meaning
                 stopped, unbound, unplugged, ...), as well as in the
                 process of being activated or deactivated,
                 i.e. between the two states (these states are called
-                'activating', 'deactivating'). A special 'failed'
-                state is available as well which is very similar to
-                'inactive' and is entered when the service failed in
+                "activating", "deactivating"). A special "failed"
+                state is available as well, which is very similar to
+                "inactive" and is entered when the service failed in
                 some way (process returned error code on exit, or
                 crashed, or an operation timed out). If this state is
-                entered the cause will be logged, for later
+                entered, the cause will be logged, for later
                 reference. Note that the various unit types may have a
                 number of additional substates, which are mapped to
                 the five generalized unit states described
diff --git a/man/udev.xml b/man/udev.xml
index 435dec4..0220725 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -712,7 +712,7 @@
       used to override a system-supplied hwdb file with a local file if needed;
       a symlink in <filename>/etc</filename> with the same name as a rules file in
       <filename>/lib</filename>, pointing to <filename>/dev/null</filename>,
-      disables the rules file entirely. Hwdb files must have the extension
+      disables the rules file entirely. hwdb files must have the extension
       <filename>.hwdb</filename>; other extensions are ignored.</para>
 
       <para>The hwdb file contains data records consisting of matches and
-- 
1.8.2



More information about the systemd-devel mailing list