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

Jan Engelhardt jengelh at inai.de
Wed Nov 6 16:17:48 PST 2013


This is a recurring submission and includes corrections to various
issue spotted: comma setting, missing words/preposition choice.
---
 man/hostnamectl.xml           | 2 +-
 man/localectl.xml             | 2 +-
 man/loginctl.xml              | 2 +-
 man/machinectl.xml            | 6 +++---
 man/systemctl.xml             | 8 ++++----
 man/systemd-analyze.xml       | 4 ++--
 man/systemd-halt.service.xml  | 4 ++--
 man/systemd-run.xml           | 4 ++--
 man/systemd-socket-proxyd.xml | 2 +-
 man/systemd-system.conf.xml   | 6 +++---
 man/systemd.mount.xml         | 4 ++--
 man/systemd.service.xml       | 6 +++---
 man/systemd.socket.xml        | 2 +-
 man/systemd.swap.xml          | 2 +-
 man/timedatectl.xml           | 2 +-
 15 files changed, 28 insertions(+), 28 deletions(-)

diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
index b39fb55..29914b8 100644
--- a/man/hostnamectl.xml
+++ b/man/hostnamectl.xml
@@ -133,7 +133,7 @@
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
-                                talk to a remote
+                                talk to the remote
                                 system.</para></listitem>
                         </varlistentry>
 
diff --git a/man/localectl.xml b/man/localectl.xml
index ad4f3d4..0950cce 100644
--- a/man/localectl.xml
+++ b/man/localectl.xml
@@ -126,7 +126,7 @@
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
-                                talk to a remote
+                                talk to the remote
                                 system.</para></listitem>
                         </varlistentry>
 
diff --git a/man/loginctl.xml b/man/loginctl.xml
index 1b54ff7..7d4f26a 100644
--- a/man/loginctl.xml
+++ b/man/loginctl.xml
@@ -172,7 +172,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
diff --git a/man/machinectl.xml b/man/machinectl.xml
index c06d0c7..ec2aaa5 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -105,7 +105,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host=</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
@@ -117,7 +117,7 @@
                                 <term><option>-M</option></term>
                                 <term><option>--machine=</option></term>
 
-                                <listitem><para>Execute operation on a
+                                <listitem><para>Execute the operation on a
                                 local container. Specify a container
                                 name to connect to.</para></listitem>
                         </varlistentry>
@@ -270,7 +270,7 @@
                                 <listitem><para>Open a terminal login
                                 session to a container. This will
                                 create a TTY connection to a specific
-                                container and asks for execution of a
+                                container and asks for the execution of a
                                 getty on it. Note that this is only
                                 supported for containers running
                                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 605b786..c7313ed 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -64,15 +64,15 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     system and service manager.</para>
 
-    <para>For Unit Commands the <replaceable>NAME</replaceable> represents full name of unit.
+    <para>For unit commands, the <replaceable>NAME</replaceable> represents full name of the unit.
     <programlisting>
 systemctl start foo.service
     </programlisting>
-    For Unit File Commands the <replaceable>NAME</replaceable> represents full name of the unit file, or absolute path to the unit file.
+    For unit file commands, the <replaceable>NAME</replaceable> represents the full name of the unit file, or the absolute path to the unit file.
     <programlisting>
 systemctl start /path/to/foo.service
     </programlisting>
-    While working with services/service files, <command>systemctl</command> is able to append .service suffix when it is missing.
+    While working with services/service files, <command>systemctl</command> implicitly appends the ".service" suffix when it is missing.
     <programlisting>
 systemctl start foo
     </programlisting></para>
@@ -457,7 +457,7 @@ systemctl start foo
         <term><option>--host</option></term>
 
         <listitem>
-          <para>Execute operation remotely. Specify a hostname, or
+          <para>Execute the operation remotely. Specify a hostname, or
           username and hostname separated by <literal>@</literal>, to connect to. This
           will use SSH to talk to the remote systemd
           instance.</para>
diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml
index 3141361..1898ca6 100644
--- a/man/systemd-analyze.xml
+++ b/man/systemd-analyze.xml
@@ -209,7 +209,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host=</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by
                                 <literal>@</literal>, to connect
@@ -222,7 +222,7 @@
                                 <term><option>-M</option></term>
                                 <term><option>--machine=</option></term>
 
-                                <listitem><para>Execute operation on a
+                                <listitem><para>Execute the operation on a
                                 local container. Specify a container
                                 name to connect to.</para></listitem>
                         </varlistentry>
diff --git a/man/systemd-halt.service.xml b/man/systemd-halt.service.xml
index 812281e..2fd7b8b 100644
--- a/man/systemd-halt.service.xml
+++ b/man/systemd-halt.service.xml
@@ -74,11 +74,11 @@
                 <filename>kexec.target</filename> to execute the
                 respective actions.</para>
 
-                <para>When these services are run they ensure that PID
+                <para>When these services are run, they ensure that PID
                 1 is replaced by the
                 <filename>/usr/lib/systemd/systemd-shutdown</filename>
                 tool which is then responsible for the actual
-                shutdown. Before shutting down this binary will try to
+                shutdown. Before shutting down, this binary will try to
                 unmount all remaining file systems, disable all
                 remaining swap devices, detach all remaining storage
                 devices and kill all remaining processes.</para>
diff --git a/man/systemd-run.xml b/man/systemd-run.xml
index 031c207..daf2bdc 100644
--- a/man/systemd-run.xml
+++ b/man/systemd-run.xml
@@ -125,7 +125,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
               <term><option>-H</option></term>
               <term><option>--host=</option></term>
 
-              <listitem><para>Execute operation
+              <listitem><para>Execute the operation
               remotely. Specify a hostname, or
               username and hostname separated by <literal>@</literal>,
               to connect to. This will use SSH to
@@ -137,7 +137,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
               <term><option>-M</option></term>
               <term><option>--machine=</option></term>
 
-              <listitem><para>Execute operation on a
+              <listitem><para>Execute the operation on a
               local container. Specify a container
               name to connect to.</para></listitem>
       </varlistentry>
diff --git a/man/systemd-socket-proxyd.xml b/man/systemd-socket-proxyd.xml
index fcf4aaf..6983346 100644
--- a/man/systemd-socket-proxyd.xml
+++ b/man/systemd-socket-proxyd.xml
@@ -64,7 +64,7 @@
                 local or remote destination socket.</para>
 
                 <para>One use of this tool is to provide
-                socket-activation support for services that do not
+                socket activation support for services that do not
                 natively support socket activation. On behalf of the
                 service to activate, the proxy inherits the socket
                 from systemd, accepts each client connection, opens a
diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml
index c1f2648..2a0a10c 100644
--- a/man/systemd-system.conf.xml
+++ b/man/systemd-system.conf.xml
@@ -101,15 +101,15 @@
                                 <listitem><para>Configures the default
                                 time-outs for starting and stopping of
                                 units, as well as the default time to
-                                sleep between automatic restarts of a
+                                sleep between automatic restarts of
                                 units, as configured per-unit in
                                 <varname>TimeoutStartSec=</varname>,
                                 <varname>TimeoutStopSec=</varname> and
                                 <varname>RestartSec=</varname> (for
-                                service units see
+                                service units, see
                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details on the per-unit
-                                settings). For non-service units
+                                settings). For non-service units,
                                 <varname>DefaultTimeoutStartSec=</varname>
                                 sets the default
                                 <varname>TimeoutSec=</varname> value.
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index daf1189..bd50f35 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -260,8 +260,8 @@
                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
-                                logic. Default value is setted up in manager configuration
-                                file via <varname>DefaultTimeoutStart=</varname>.</para></listitem>
+                                logic. The default value is set from the manager configuration
+                                file's <varname>DefaultTimeoutStart=</varname> variable.</para></listitem>
                         </varlistentry>
                 </variablelist>
 
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 0cb3d9e..d1f4a2d 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -524,10 +524,10 @@
                                 Takes a unit-less value in seconds, or a
                                 time span value such as "5min
                                 20s". Pass 0 to disable the timeout
-                                logic. Defaults to <varname>TimeoutStartSec=</varname> in
+                                logic. Defaults to <varname>TimeoutStartSec=</varname> from the
                                 manager configuration file, except when
                                 <varname>Type=oneshot</varname> is
-                                used in which case the timeout
+                                used, in which case the timeout
                                 is disabled by default.
                                 </para></listitem>
                         </varlistentry>
@@ -546,7 +546,7 @@
                                 Takes a unit-less value in seconds, or a
                                 time span value such as "5min
                                 20s". Pass 0 to disable the timeout
-                                logic. Defaults to <varname>TimeoutStartSec=</varname> in
+                                logic. Defaults to <varname>TimeoutStartSec=</varname> from the
                                 manager configuration file.
                                 </para></listitem>
                         </varlistentry>
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 1c78562..7c10c58 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -679,7 +679,7 @@
                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
-                                logic. Defaults to <varname>TimeoutStartSec=</varname> in
+                                logic. Defaults to <varname>TimeoutStartSec=</varname> from the
                                 manager configuration file.</para></listitem>
                         </varlistentry>
 
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 13f6c84..0411232 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -186,7 +186,7 @@
                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
-                                logic. Defaults to <varname>TimeoutStartSec=</varname> in
+                                logic. Defaults to <varname>TimeoutStartSec=</varname> from the
                                 manager configuration file.</para></listitem>
                         </varlistentry>
                 </variablelist>
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 2dd6beb..afcb716 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -101,7 +101,7 @@
                                 <term><option>-H</option></term>
                                 <term><option>--host=</option></term>
 
-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation
                                 remotely. Specify a hostname, or
                                 username and hostname separated by <literal>@</literal>,
                                 to connect to. This will use SSH to
-- 
1.8.2



More information about the systemd-devel mailing list