man: improvements to comma placement

jengelh · keszybz · commit b040723ea412 · 2013-12-25T22:53:46.000-05:00
This is a recurring submission and includes corrections to:
comma placement.
diff --git a/man/halt.xml b/man/halt.xml
@@ -148,7 +148,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
@@ -255,7 +255,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/journalctl.xml b/man/journalctl.xml
@@ -691,7 +691,7 @@
                                 matching <replaceable>GLOB</replaceable>
                                 instead of the default runtime and
                                 system journal paths. May be specified
-                                multiple times, in which case, files will
+                                multiple times, in which case files will
                                 be suitably interleaved.</para></listitem>
                         </varlistentry>
 
diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml
@@ -83,7 +83,7 @@
                 <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                 <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for more information about the functions
-                implemented. In addition to these functions a couple
+                implemented. In addition to these functions, a couple
                 of logging prefixes are defined as macros:</para>
 
                 <programlisting>#define SD_EMERG   "&lt;0&gt;"  /* system is unusable */
@@ -135,7 +135,7 @@
                 implementation. See the respective function man pages
                 for details.</para>
 
-                <para>In addition, for details about the algorithms
+                <para>In addition, for details about the algorithms,
                 check the liberally licensed reference implementation
                 sources:
                 <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
diff --git a/man/sd-readahead.xml b/man/sd-readahead.xml
@@ -83,7 +83,7 @@
                 reference implementation. See the respective function
                 man pages for details.</para>
 
-                <para>In addition, for details about the algorithms
+                <para>In addition, for details about the algorithms,
                 check the liberally licensed reference implementation
                 sources:
                 <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/readahead/sd-readahead.c"/>
diff --git a/man/sd_booted.xml b/man/sd_booted.xml
@@ -106,7 +106,7 @@
                 file. Alternatively, applications consuming these APIs
                 may copy the implementation into their source
                 tree. For more details about the reference
-                implementation see
+                implementation, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>If the reference implementation is used as
diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml
@@ -78,7 +78,7 @@
                 <para><function>sd_bus_message_get_reply_cookie()</function>
                 returns the transaction cookie of the message the
                 specified message is a response to. When a reply
-                message is generated for a method call message its
+                message is generated for a method call message, its
                 cookie is copied over into this field. Note that while
                 every message that is transferred is identified by a
                 cookie, only response messages carry a reply cookie
@@ -96,7 +96,7 @@
                 integer. On failure, these calls return a negative
                 errno-style error code.</para>
 
-                <para>On success the cookie/reply cookie is returned
+                <para>On success, the cookie/reply cookie is returned
                 in the specified 64bit unsigned integer variable.</para>
         </refsect1>
 
diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml
@@ -87,7 +87,7 @@
                                 <varname>SD_BUS_NAME_REPLACE_EXISTING</varname>
                                 flag set. If
                                 <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname>
-                                is not set on the original request
+                                is not set on the original request,
                                 such a request by other peers will be
                                 denied.</para></listitem>
                         </varlistentry>
@@ -125,10 +125,10 @@
                 errno-style error code.</para>
 
                 <para>If <varname>SD_BUS_NAME_QUEUE</varname> is
-                specified <function>sd_bus_request_name()</function>
+                specified, <function>sd_bus_request_name()</function>
                 will return 0 when the name is already taken by
                 another peer and the client has been added to the
-                queue for the name. In that case the caller can
+                queue for the name. In that case, the caller can
                 subscribe to <literal>NameOwnerChanged</literal>
                 signals to be notified when the name is successfully
                 acquired. <function>sd_bus_request_name()</function>
diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml
@@ -107,7 +107,7 @@
         <refsect1>
                 <title>Return Value</title>
 
-                <para>On success <function>sd_get_seats()</function>,
+                <para>On success, <function>sd_get_seats()</function>,
                 <function>sd_get_sessions()</function>,
                 <function>sd_get_uids()</function> and
                 <function>sd_get_machine_names()</function> return the
diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml
@@ -214,7 +214,7 @@
                 file. Alternatively, applications consuming these APIs
                 may copy the implementation into their source
                 tree. For more details about the reference
-                implementation see
+                implementation, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>These functions continue to work as described,
diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml
@@ -155,7 +155,7 @@
                 file. Alternatively, applications consuming these APIs
                 may copy the implementation into their source
                 tree. For more details about the reference
-                implementation see
+                implementation, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>If the reference implementation is used as
diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml
@@ -198,13 +198,13 @@ else {
         <refsect1>
                 <title>Return Value</title>
 
-                <para>On success
+                <para>On success,
                 <function>sd_login_monitor_new()</function>,
                 <function>sd_login_monitor_flush()</function> and
                 <function>sd_login_monitor_get_timeout()</function>
-                return 0 or a positive integer. On success
+                return 0 or a positive integer. On success,
                 <function>sd_login_monitor_get_fd()</function> returns
-                a Unix file descriptor. On success
+                a Unix file descriptor. On success,
                 <function>sd_login_monitor_get_events()</function>
                 returns a combination of <constant>POLLIN</constant>,
                 <constant>POLLOUT</constant> and suchlike. On failure,
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
@@ -245,7 +245,7 @@
                 <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file. Alternatively, applications consuming these APIs
                 may copy the implementation into their source tree. For
-                more details about the reference implementation see
+                more details about the reference implementation, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>If the reference implementation is used as
diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml
@@ -139,7 +139,7 @@
                 <filename>sd-readahead.h</filename> files. It is
                 recommended that applications consuming this API copy
                 the implementation into their source tree. For more
-                details about the reference implementation see
+                details about the reference implementation, see
                 <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
 
                 <para>If -DDISABLE_SYSTEMD is set during compilation,
diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
@@ -143,9 +143,9 @@
         <refsect1>
                 <title>Return Value</title>
 
-                <para> On success
+                <para> On success,
                 <function>sd_seat_get_active()</function>
-                returns 0 or a positive integer. On success
+                returns 0 or a positive integer. On success,
                 <function>sd_seat_get_sessions()</function> returns
                 the number of entries in the session identifier
                 array. If the test succeeds,
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
@@ -270,7 +270,7 @@
                 <para>If the test succeeds,
                 <function>sd_session_is_active()</function> and
                 <function>sd_session_is_remote()</function> return a
-                positive integer, if it fails 0.  On success
+                positive integer; if it fails, 0.  On success,
                 <function>sd_session_get_state()</function>,
                 <function>sd_session_get_uid()</function>,
                 <function>sd_session_get_seat()</function>,
diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml
@@ -152,11 +152,11 @@
         <refsect1>
                 <title>Return Value</title>
 
-                <para>On success
+                <para>On success,
                 <function>sd_uid_get_state()</function> returns 0 or a
                 positive integer. If the test succeeds,
                 <function>sd_uid_is_on_seat()</function> returns a
-                positive integer, if it fails
+                positive integer; if it fails,
                 0. <function>sd_uid_get_sessions()</function> and
                 <function>sd_uid_get_seats()</function> return the
                 number of entries in the returned arrays. On failure,
diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml
@@ -80,7 +80,7 @@
                 inherited by child processes.</para>
 
                 <para>If the <parameter>usec</parameter> parameter is
-                non-NULL <function>sd_watchdog_enabled()</function>
+                non-NULL, <function>sd_watchdog_enabled()</function>
                 will return the timeout in µs for the watchdog
                 logic. The service manager will usually terminate a
                 service when it did not get a notification message
@@ -94,7 +94,7 @@
                 <literal>WATCHDOG=1</literal>.</para>
 
                 <para>To enable service supervision with the watchdog
-                logic use <varname>WatchdogSec=</varname> in service
+                logic, use <varname>WatchdogSec=</varname> in service
                 files. See
                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for details.</para>
@@ -107,7 +107,7 @@
                 errno-style error code. If the service manager expects
                 watchdog keep-alive notification messages to be sent,
                 &gt; 0 is returned, otherwise 0 is returned. Only if
-                the return value is &gt; 0 the
+                the return value is &gt; 0, the
                 <parameter>usec</parameter> parameter is valid after
                 the call.</para>
         </refsect1>
@@ -129,10 +129,10 @@
                 variable. The call will ignore these variables if
                 <varname>$WATCHDOG_PID</varname> does containe the PID
                 of the current process, under the assumption that in
-                that case the variables were set for a different
+                that case, the variables were set for a different
                 process further up the process tree.</para>
 
-                <para>For details about the algorithm check the
+                <para>For details about the algorithm, check the
                 liberally licensed reference implementation sources:
                 <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
                 and <ulink
@@ -148,7 +148,7 @@
                 file. Alternatively, applications consuming these APIs
                 may copy the implementation into their source
                 tree. For more details about the reference
-                implementation see
+                implementation, see
                 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>If the reference implementation is used as
diff --git a/man/shutdown.xml b/man/shutdown.xml
@@ -164,7 +164,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemctl.xml b/man/systemctl.xml
@@ -238,7 +238,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         applications.</para>
 
         <para><literal>ignore-requirements</literal> is similar to
-        <literal>ignore-dependencies</literal> but only causes the
+        <literal>ignore-dependencies</literal>, but only causes the
         requirement dependencies to be ignored, the ordering
         dependencies will still be honoured.</para>
         </listitem>
@@ -1383,7 +1383,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
     <refsect2>
       <title>Parameter Syntax</title>
 
-    <para>For unit commands the specified
+    <para>For unit commands, the specified
     <replaceable>NAME</replaceable> should be the full name of the
     unit, or an abbreviated name which is automatically extended with
     the <literal>.service</literal> suffix.
@@ -1395,7 +1395,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
     <programlisting># systemctl status dev-sda.device
 # systemctl status home.mount</programlisting></para>
 
-    <para>For unit file commands the
+    <para>For unit file commands, the
     specified <replaceable>NAME</replaceable> should be the full name
     of the unit file, or the absolute path to the unit file.
     <programlisting># systemctl link /path/to/foo.service</programlisting>
diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml
@@ -300,7 +300,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml
@@ -167,7 +167,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml
@@ -158,7 +158,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml
@@ -145,7 +145,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml
@@ -264,7 +264,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml
@@ -200,7 +200,7 @@
 
         <refsect1>
                 <title>Exit status</title>
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise. Not finding any matching coredumps is treated
                 as failure.
                 </para>
diff --git a/man/systemd-delta.xml b/man/systemd-delta.xml
@@ -223,7 +223,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml
@@ -116,7 +116,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml
@@ -172,7 +172,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml
@@ -183,7 +183,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml
@@ -148,7 +148,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
diff --git a/man/systemd.device.xml b/man/systemd.device.xml
@@ -75,7 +75,7 @@
                 udev tag (by default all block and network devices,
                 and a few others). This may be used to define
                 dependencies between devices and other units. To tag a
-                udev device use <literal>TAG+="systemd"</literal> in
+                udev device, use <literal>TAG+="systemd"</literal> in
                 the udev rules file, see
                 <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 for details.</para>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
diff --git a/man/systemd.xml b/man/systemd.xml
diff --git a/man/telinit.xml b/man/telinit.xml
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
