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

Jan Engelhardt jengelh at inai.de
Sun Aug 25 00:01:45 PDT 2013


This includes regularly-submitted corrections to comma setting and
orthographical mishaps that appeared in man/ in recent commits.

In this particular commit:
- the usual comma fixes
- expand contractions (this is prose)
---
 man/journalctl.xml                 |  2 +-
 man/sd_journal_get_cursor.xml      |  2 +-
 man/sd_journal_get_fd.xml          | 14 +++++++-------
 man/sd_notify.xml                  |  2 +-
 man/shutdown.xml                   |  4 ++--
 man/systemd-backlight at .service.xml |  4 ++--
 man/systemd-cgls.xml               |  2 +-
 man/systemd-efi-boot-generator.xml |  4 ++--
 man/systemd-nspawn.xml             |  2 +-
 man/systemd.exec.xml               |  9 ++++-----
 man/systemd.journal-fields.xml     |  2 +-
 man/systemd.mount.xml              |  2 +-
 man/systemd.service.xml            |  4 ++--
 man/systemd.special.xml            |  2 +-
 man/systemd.time.xml               |  2 +-
 man/systemd.xml                    |  2 +-
 man/telinit.xml                    |  2 +-
 man/timedatectl.xml                |  2 +-
 man/tmpfiles.d.xml                 | 12 ++++++------
 19 files changed, 37 insertions(+), 38 deletions(-)

diff --git a/man/journalctl.xml b/man/journalctl.xml
index 8680e53..e7097d6 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -281,7 +281,7 @@
                                                         <option>short-monotonic</option>
                                                 </term>
                                                 <listitem>
-                                                        <para>is very similar
+                                                        <para>is very similar,
                                                         but shows monotonic
                                                         timestamps instead of
                                                         wallclock timestamps.
diff --git a/man/sd_journal_get_cursor.xml b/man/sd_journal_get_cursor.xml
index 861927e..4cee7d5 100644
--- a/man/sd_journal_get_cursor.xml
+++ b/man/sd_journal_get_cursor.xml
@@ -120,7 +120,7 @@
                 returns 0 on success or a negative errno-style error
                 code. <function>sd_journal_test_cursor()</function>
                 returns positive if the current entry matches the
-                specified cursor, 0 if it doesn't match the specified
+                specified cursor, 0 if it does not match the specified
                 cursor or a negative errno-style error code on
                 failure.</para>
         </refsect1>
diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml
index 1c6f250..c4387b0 100644
--- a/man/sd_journal_get_fd.xml
+++ b/man/sd_journal_get_fd.xml
@@ -232,15 +232,15 @@ else {
                 <constant>SD_JOURNAL_APPEND</constant> or
                 <constant>SD_JOURNAL_INVALIDATE</constant> on success or
                 a negative errno-style error code. If
-                <constant>SD_JOURNAL_NOP</constant> is returned the
-                journal didn't change since the last invocation. If
-                <constant>SD_JOURNAL_APPEND</constant> is returned new
+                <constant>SD_JOURNAL_NOP</constant> is returned, the
+                journal did not change since the last invocation. If
+                <constant>SD_JOURNAL_APPEND</constant> is returned, new
                 entries have been appended to the end of the
-                journal. If <constant>SD_JOURNAL_INVALIDATE</constant>
+                journal. If <constant>SD_JOURNAL_INVALIDATE</constant>,
                 journal files were added or removed (possibly due to
-                rotation). In the latter event live-view UIs should
-                probably refresh their entire display while in the
-                case of <constant>SD_JOURNAL_APPEND</constant> it is
+                rotation). In the latter event, live-view UIs should
+                probably refresh their entire display, while in the
+                case of <constant>SD_JOURNAL_APPEND</constant>, it is
                 sufficient to simply continue reading at the previous
                 end of the journal.</para>
         </refsect1>
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 7d96890..fc0f2f6 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -200,7 +200,7 @@
                 the status was sent these functions return with a
                 positive return value. In order to support both, init
                 systems that implement this scheme and those which
-                don't, it is generally recommended to ignore the return
+                do not, it is generally recommended to ignore the return
                 value of this call.</para>
         </refsect1>
 
diff --git a/man/shutdown.xml b/man/shutdown.xml
index af799c6..795fb66 100644
--- a/man/shutdown.xml
+++ b/man/shutdown.xml
@@ -133,7 +133,7 @@
                         <varlistentry>
                                 <term><option>-k</option></term>
 
-                                <listitem><para>Don't halt, power-off,
+                                <listitem><para>Do not halt, power-off,
                                 reboot, just write wall
                                 message.</para></listitem>
                         </varlistentry>
@@ -141,7 +141,7 @@
                         <varlistentry>
                                 <term><option>--no-wall</option></term>
 
-                                <listitem><para>Don't send wall
+                                <listitem><para>Do not send wall
                                 message before
                                 halt, power-off, reboot.</para></listitem>
                         </varlistentry>
diff --git a/man/systemd-backlight at .service.xml b/man/systemd-backlight at .service.xml
index f2f5472..2b73625 100644
--- a/man/systemd-backlight at .service.xml
+++ b/man/systemd-backlight at .service.xml
@@ -57,9 +57,9 @@
                 <para><filename>systemd-backlight at .service</filename>
                 is a service that restores the display backlight
                 brightness at early-boot and saves it at shutdown. On
-                disk the backlight brightness is stored in
+                disk, the backlight brightness is stored in
                 <filename>/var/lib/backlight/</filename>. Note that by
-                default only firmware backlight devices are
+                default, only firmware backlight devices are
                 saved/restored.</para>
         </refsect1>
 
diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml
index 53e7f7d..2877f22 100644
--- a/man/systemd-cgls.xml
+++ b/man/systemd-cgls.xml
@@ -107,7 +107,7 @@
                         <varlistentry>
                                 <term><option>--all</option></term>
 
-                                <listitem><para>Don't hide empty
+                                <listitem><para>Do not hide empty
                                 control groups in the
                                 output.</para></listitem>
                         </varlistentry>
diff --git a/man/systemd-efi-boot-generator.xml b/man/systemd-efi-boot-generator.xml
index 03a4fdd..3a79dfb 100644
--- a/man/systemd-efi-boot-generator.xml
+++ b/man/systemd-efi-boot-generator.xml
@@ -56,7 +56,7 @@
 
                 <para><filename>systemd-efi-boot-generator</filename>
                 is a generator that automatically creates mount and
-                automount units for the EFI System Partition (ESP)
+                automount units for the EFI System Partition (ESP),
                 mounting it to <filename>/boot</filename>. Note that
                 this generator will execute no operation on non-EFI
                 systems, on systems where the boot loader does not
@@ -64,7 +64,7 @@
                 <filename>/boot</filename> is an explicitly configured
                 mount (for example, listed in <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>) or where the <filename>/boot</filename> mount
                 point is non-empty. Since this generator creates an
-                automount unit the mount will only be activated
+                automount unit, the mount will only be activated
                 on-demand, when accessed.</para>
 
                 <para><filename>systemd-efi-boot-generator</filename>
diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
index e55933d0..6264e48 100644
--- a/man/systemd-nspawn.xml
+++ b/man/systemd-nspawn.xml
@@ -334,7 +334,7 @@
                                 <filename>/var/log/journal</filename>
                                 exists, it will be bind mounted
                                 into the container. If the
-                                subdirectory doesn't exist, no
+                                subdirectory does not exist, no
                                 linking is performed. Effectively,
                                 booting a container once with
                                 <literal>guest</literal> or
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index b761832..2c673a2 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -1,4 +1,3 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
@@ -327,8 +326,8 @@
                                 absolute filename or wildcard
                                 expression, optionally prefixed with
                                 <literal>-</literal>, which indicates
-                                that if the file does not exist it
-                                won't be read and no error or warning
+                                that if the file does not exist, it
+                                will not be read and no error or warning
                                 message is logged.  This option may be
                                 specified more than once in which case
                                 all specified files are read. If the
@@ -835,7 +834,7 @@
                                 <varname>InaccessibleDirectories=</varname>
                                 may be prefixed with
                                 <literal>-</literal>, in which case
-                                they will be ignored when they don't
+                                they will be ignored when they do not
                                 exist.</para></listitem>
                         </varlistentry>
 
@@ -972,7 +971,7 @@
                                 <function>sigreturn</function>,
                                 <function>exit_group</function>,
                                 <function>exit</function> system calls
-                                are implicitly whitelisted and don't
+                                are implicitly whitelisted and do not
                                 need to be listed explicitly. This
                                 option may be specified more than once
                                 in which case the filter masks are
diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml
index 452406c..cffcccb 100644
--- a/man/systemd.journal-fields.xml
+++ b/man/systemd.journal-fields.xml
@@ -525,7 +525,7 @@
                 url="http://www.freedesktop.org/wiki/Software/systemd/json">Journal
                 JSON Format</ulink>, the addresses of journal entries
                 are serialized into fields prefixed with double
-                underscores. Note that these aren't proper fields when
+                underscores. Note that these are not proper fields when
                 stored in the journal but for addressing meta data of
                 entries. They cannot be written as part of structured
                 log entries via calls such as
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index 214f40c..9aac94e 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -84,7 +84,7 @@
                 using configuration not specified in
                 <filename>/etc/fstab</filename>;
                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                will refuse options that aren't listed in
+                will refuse options that are not listed in
                 <filename>/etc/fstab</filename> if it is not run as
                 UID 0.</para>
 
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 238a49a..5df554c 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -483,7 +483,7 @@
                                 was stopped. This includes cases where
                                 the commands configured in
                                 <varname>ExecStop=</varname> were used,
-                                where the service doesn't have any
+                                where the service does not have any
                                 <varname>ExecStop=</varname> defined, or
                                 where the service exited unexpectedly. This
                                 argument takes multiple command lines,
@@ -823,7 +823,7 @@
                                 in other words: the
                                 <varname>Service=</varname> setting of
                                 <filename>.socket</filename> units
-                                doesn't have to match the inverse of
+                                does not have to match the inverse of
                                 the <varname>Sockets=</varname>
                                 setting of the
                                 <filename>.service</filename> it
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index e1299ab..da29660 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -448,7 +448,7 @@
                                         after it. Note that networking
                                         daemons that simply provide
                                         functionality to other hosts
-                                        generally don't need to pull
+                                        generally do not need to pull
                                         this in.</para>
                                         </listitem>
                         </varlistentry>
diff --git a/man/systemd.time.xml b/man/systemd.time.xml
index 4f6dd0f..3d13b57 100644
--- a/man/systemd.time.xml
+++ b/man/systemd.time.xml
@@ -127,7 +127,7 @@
                 but when the weekday is specified it must either be
                 in the abbreviated (<literal>Wed</literal>) or
                 non-abbreviated (<literal>Wednesday</literal>) English
-                language form (case doesn't matter), and is not
+                language form (case does not matter), and is not
                 subject to the locale choice of the user. Either the
                 date, or the time part may be omitted, in which case
                 the current date or 00:00:00, resp., is assumed. The
diff --git a/man/systemd.xml b/man/systemd.xml
index 9f58bc2..47d6438 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -1022,7 +1022,7 @@
                                 option prefixed with
                                 <literal>rd.</literal> is honored
                                 only in the initial RAM disk (initrd),
-                                while the one that isn't prefixed only
+                                while the one that is not prefixed only
                                 in the main system.</para></listitem>
                         </varlistentry>
 
diff --git a/man/telinit.xml b/man/telinit.xml
index 4c6064f..bb80939 100644
--- a/man/telinit.xml
+++ b/man/telinit.xml
@@ -80,7 +80,7 @@
                         <varlistentry>
                                 <term><option>--no-wall</option></term>
 
-                                <listitem><para>Don't send wall
+                                <listitem><para>Do not send wall
                                 message before
                                 reboot/halt/power-off.</para></listitem>
                         </varlistentry>
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 16ee3df..9aade29 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -92,7 +92,7 @@
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 
-                                <listitem><para>Don't query the user
+                                <listitem><para>Do not query the user
                                 for authentication for privileged
                                 operations.</para></listitem>
                         </varlistentry>
diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 6a2193d..025c801 100644
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -104,7 +104,7 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
                         <variablelist>
                                 <varlistentry>
                                         <term><varname>f</varname></term>
-                                        <listitem><para>Create a file if it doesn't exist yet (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
+                                        <listitem><para>Create a file if it does not exist yet (optionally writing a short string into it, if the argument parameter is passed)</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
@@ -122,7 +122,7 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 
                                 <varlistentry>
                                         <term><varname>d</varname></term>
-                                        <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a directory if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
@@ -132,22 +132,22 @@ L    /tmp/foobar -    -    -    -   /dev/null</programlisting>
 
                                 <varlistentry>
                                         <term><varname>p</varname></term>
-                                        <listitem><para>Create a named pipe (FIFO) if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a named pipe (FIFO) if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>L</varname></term>
-                                        <listitem><para>Create a symlink if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a symlink if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>c</varname></term>
-                                        <listitem><para>Create a character device node if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a character device node if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
                                         <term><varname>b</varname></term>
-                                        <listitem><para>Create a block device node if it doesn't exist yet</para></listitem>
+                                        <listitem><para>Create a block device node if it does not exist yet</para></listitem>
                                 </varlistentry>
 
                                 <varlistentry>
-- 
1.8.2



More information about the systemd-devel mailing list