[systemd-devel] [PATCH 3/3] man: grammar and wording improvements
Jan Engelhardt
jengelh at inai.de
Wed Dec 25 17:47:45 PST 2013
This is a recurring submission and includes corrections to:
- missing words, preposition choice.
- change of /lib to /usr/lib, because that is what most distros are
using as the system-wide location for systemd/udev files.
---
man/daemon.xml | 2 +-
man/journalctl.xml | 4 ++--
man/sd_bus_message_get_cookie.xml | 6 +++---
man/sd_bus_request_name.xml | 20 ++++++++++----------
man/sd_is_fifo.xml | 2 +-
man/systemctl.xml | 8 ++++----
man/systemd-networkd.service.xml | 8 ++++----
man/systemd.device.xml | 2 +-
man/systemd.exec.xml | 4 ++--
man/systemd.service.xml | 2 +-
man/systemd.timer.xml | 10 +++++-----
man/systemd.unit.xml | 2 +-
man/udev.xml | 12 ++++++------
13 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/man/daemon.xml b/man/daemon.xml
index 7790420..1fe4546 100644
--- a/man/daemon.xml
+++ b/man/daemon.xml
@@ -408,7 +408,7 @@
description files.</para>
<para>In systemd, if the developer or
- administrator wants to make sure a service or
+ administrator wants to make sure that a service or
other unit is activated automatically on boot,
it is recommended to place a symlink to the
unit file in the <filename>.wants/</filename>
diff --git a/man/journalctl.xml b/man/journalctl.xml
index 6a97210..55474c5 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -119,7 +119,7 @@
<para>When outputing to a tty, lines are colored
according to priority: lines of level ERROR and higher
are colored red; lines of level NOTICE and higher are
- highlighted; and other lines are displayed normally.
+ highlighted; other lines are displayed normally.
</para>
</refsect1>
@@ -232,7 +232,7 @@
<term><option>-r</option></term>
<term><option>--reverse</option></term>
- <listitem><para>Reverse output so the newest
+ <listitem><para>Reverse output so that the newest
entries are displayed first.</para></listitem>
</varlistentry>
diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml
index 0e3c4ba..bf403a2 100644
--- a/man/sd_bus_message_get_cookie.xml
+++ b/man/sd_bus_message_get_cookie.xml
@@ -85,7 +85,7 @@
field.</para>
<para>Both functions take a message object as first
- parameter and a place to store the 64bit cookie
+ parameter and a place to store the 64-bit cookie
in.</para>
</refsect1>
@@ -97,7 +97,7 @@
errno-style error code.</para>
<para>On success, the cookie/reply cookie is returned
- in the specified 64bit unsigned integer variable.</para>
+ in the specified 64-bit unsigned integer variable.</para>
</refsect1>
<refsect1>
@@ -122,7 +122,7 @@
been sent yet and hence has no cookie
assigned, or that the message is not a
method response message and hence
- carries to reply cookie
+ carries a reply cookie
field.</para></listitem>
</varlistentry>
</variablelist>
diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml
index c84b0b6..7393fdd 100644
--- a/man/sd_bus_request_name.xml
+++ b/man/sd_bus_request_name.xml
@@ -81,7 +81,7 @@
<term><varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname></term>
<listitem><para>After acquiring the
- name successuflly, permit other peers
+ name successfully, permit other peers
to take over the name when they try to
acquire it with the
<varname>SD_BUS_NAME_REPLACE_EXISTING</varname>
@@ -95,10 +95,10 @@
<varlistentry>
<term><varname>SD_BUS_NAME_REPLACE_EXISTING</varname></term>
- <listitem><para>Take over a the name
- if it is already acquired by a another
- peer, and that other peer permitted
- taking it over by setting
+ <listitem><para>Take over the name
+ if it is already acquired by another
+ peer, and that other peer has permitted
+ takeover by setting
<varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname>
while acquiring it.</para></listitem>
</varlistentry>
@@ -106,8 +106,8 @@
<varlistentry>
<term><varname>SD_BUS_NAME_QUEUE</varname></term>
- <listitem><para>Queue name
- acquisition when the name is already
+ <listitem><para>Queue the acquisition
+ of the name when the name is already
taken.</para></listitem>
</varlistentry>
</variablelist>
@@ -165,7 +165,7 @@
<varlistentry>
<term><varname>-ESRCH</varname></term>
- <listitem><para>It was attemted to
+ <listitem><para>It was attempted to
release a name that is currently not
registered on the
bus.</para></listitem>
@@ -174,7 +174,7 @@
<varlistentry>
<term><varname>-EADDRINUSE</varname></term>
- <listitem><para>It was attemted to
+ <listitem><para>It was attempted to
release a name that is owned by a
different peer on the
bus.</para></listitem>
@@ -199,7 +199,7 @@
<listitem><para>The bus connection has
been created in a different process
- than the current.</para></listitem>
+ than the current one.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml
index 4bb2236..58cd1c9 100644
--- a/man/sd_is_fifo.xml
+++ b/man/sd_is_fifo.xml
@@ -165,7 +165,7 @@
called to check whether the specified file descriptor
refers to a special file. If the
<parameter>path</parameter> parameter is not
- <constant>NULL</constant>, it is checked whether file
+ <constant>NULL</constant>, it is checked whether the file
descriptor is bound to the specified file
name. Special files in this context are character
device nodes and files in <filename>/proc</filename>
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 7c9ffc8..250866a 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -194,8 +194,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<term><option>--job-mode=</option></term>
<listitem>
- <para>When queuing a new job, control how to deal with already
- queued jobs. Takes one of <literal>fail</literal>,
+ <para>When queuing a new job, this option controls how to deal with
+ already queued jobs. It takes one of <literal>fail</literal>,
<literal>replace</literal>,
<literal>replace-irreversibly</literal>,
<literal>isolate</literal>,
@@ -543,7 +543,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
<listitem>
- <para>List socket units ordered by the listening address.
+ <para>List socket units ordered by listening address.
If one or more <replaceable>PATTERN</replaceable>s are
specified, only socket units matching one of them are
shown. Produces output similar to
@@ -692,7 +692,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
<listitem>
<para>Check whether any of the specified units are active
(i.e. running). Returns an exit code 0 if at least one is
- active, non-zero otherwise. Unless <option>--quiet</option>
+ active, or non-zero otherwise. Unless <option>--quiet</option>
is specified, this will also print the current unit state to
STDOUT.</para>
</listitem>
diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml
index 6c65fba..908354c 100644
--- a/man/systemd-networkd.service.xml
+++ b/man/systemd-networkd.service.xml
@@ -64,8 +64,8 @@
<para>Network configurations applied before networkd is started
are not removed, and configuration applied by networkd are not
removed when networkd exits. This ensures restarting networkd
- does not cut the network connection, and in particular that it
- is safe to transition between the initrd and the real root,
+ does not cut the network connection, and, in particular, that
+ it is safe to transition between the initrd and the real root,
and back.</para>
</refsect1>
@@ -80,10 +80,10 @@
identical filenames replace each other. Files in
<filename>/etc</filename> have the highest priority, files in
<filename>/run</filename> take precedence over files with the same
- name in <filename>/lib</filename>. This can be used to override a
+ name in <filename>/usr/lib</filename>. This can be used to override a
system-supplied configuration file with a local file if needed; a symlink in
<filename>/etc</filename> with the same name as a configuration file in
- <filename>/lib</filename>, pointing to <filename>/dev/null</filename>,
+ <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the configuration file entirely.</para>
<refsect2><title>Virtual Network Devices</title>
diff --git a/man/systemd.device.xml b/man/systemd.device.xml
index fa7074a..619fe19 100644
--- a/man/systemd.device.xml
+++ b/man/systemd.device.xml
@@ -149,7 +149,7 @@
even if it shows up in the udev
tree. If this property is unset or set
to 1, the device will be considered
- plugged if it visible in the
+ plugged if it is visible in the
udev tree. This property has no
influence on the behavior when a
device disappears from the udev
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index 2778497..17748d4 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -847,7 +847,7 @@
processes and mounts private
<filename>/tmp</filename> and
<filename>/var/tmp</filename>
- directories inside it that are not
+ directories inside it that is not
shared by processes outside of the
namespace. This is useful to secure
access to temporary files of the
@@ -857,7 +857,7 @@
<filename>/var/tmp</filename>
impossible. All temporary data created
by service will be removed after
- service is stopped. Defaults to
+ the service is stopped. Defaults to
false. Note that it is possible to run
two or more units within the same
private <filename>/tmp</filename> and
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 8e6c205..5afeffa 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -427,7 +427,7 @@
<programlisting>ExecStart=/bin/sh -c 'dmesg | tac'
</programlisting>
- <para>Only select environment variables
+ <para>Only select environment variables that
are set for executed commands. See
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 7143f9f..bb3a6d1 100644
--- a/man/systemd.timer.xml
+++ b/man/systemd.timer.xml
@@ -165,8 +165,8 @@
assignments will have no
effect.</para>
- <para>Note that timers are not
- necessarily expired at the precise
+ <para>Note that timers do not
+ necessarily expire at the precise
time configured with these settings,
as they are subject to the
<varname>AccuracySec=</varname>
@@ -187,8 +187,8 @@
<varname>OnActiveSec=</varname> and
related settings.</para>
- <para>Note that timers are not
- necessarily expired at the precise
+ <para>Note that timers do not
+ necessarily expire at the precise
time configured with this setting,
as it is subject to the
<varname>AccuracySec=</varname>
@@ -201,7 +201,7 @@
<listitem><para>Specify the accuracy
the timer shall elapse with. Defaults
to 1min. The timer is scheduled to
- expire within a time window starting
+ elapse within a time window starting
with the time specified in
<varname>OnCalendar=</varname>,
<varname>OnActiveSec=</varname>,
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 0244570..487827c 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -548,7 +548,7 @@
of units. When systemd stops or restarts
the units listed here, the action is
propagated to this unit.
- Note that this is a one way dependency —
+ Note that this is a one-way dependency —
changes to this unit do not affect the
listed units.
</para></listitem>
diff --git a/man/udev.xml b/man/udev.xml
index bd071e1..32a520e 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -63,10 +63,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence
- over files with the same name in <filename>/lib</filename>. This can be
+ over files with the same name in <filename>/usr/lib</filename>. This can be
used to override a system-supplied rules 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>,
+ <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the rules file entirely. Rule files must have the extension
<filename>.rules</filename>; other extensions are ignored.</para>
@@ -715,10 +715,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence
- over files with the same name in <filename>/lib</filename>. This can be
+ over files with the same name in <filename>/usr/lib</filename>. This can be
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 hwdb file in
- <filename>/lib</filename>, pointing to <filename>/dev/null</filename>,
+ <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the hwdb file entirely. hwdb files must have the extension
<filename>.hwdb</filename>; other extensions are ignored.</para>
@@ -754,10 +754,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in <filename>/etc</filename>
have the highest priority, files in <filename>/run</filename> take precedence
- over files with the same name in <filename>/lib</filename>. This can be
+ over files with the same name in <filename>/usr/lib</filename>. This can be
used to override a system-supplied link file with a local file if needed;
a symlink in <filename>/etc</filename> with the same name as a link file in
- <filename>/lib</filename>, pointing to <filename>/dev/null</filename>,
+ <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>,
disables the link file entirely.</para>
<para>The link file contains a <literal>[Match]</literal> section, which
--
1.8.4
More information about the systemd-devel
mailing list