chiark / gitweb /
man: wording and grammar updates
authorJan Engelhardt <jengelh@inai.de>
Mon, 21 Oct 2013 23:50:48 +0000 (01:50 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 22 Oct 2013 00:50:46 +0000 (20:50 -0400)
This is a recurring submission and includes corrections to various
issue spotted.

DISTRO_PORTING
README
TODO
man/kernel-command-line.xml
man/systemd-fstab-generator.xml
man/systemd-socket-proxyd.xml

index 5088fac..d799e53 100644 (file)
@@ -23,12 +23,12 @@ HOWTO:
 
 CONTRIBUTING UPSTREAM:
 
-        We are generally do no longer accept distribution specific
+        We do generally no longer accept distribution-specific
         patches to systemd upstream. If you have to make changes to
         systemd's source code to make it work on your distribution:
-        unless your code is generic enough to be generally useful we
+        unless your code is generic enough to be generally useful, we
         are unlikely to merge it. Please always consider adopting the
-        upstream defaults. If that's not possible please maintain the
-        relevant patches downstream.
+        upstream defaults. If that is not possible, please maintain
+        the relevant patches downstream.
 
         Thank you for understanding.
diff --git a/README b/README
index cf0a18d..2321849 100644 (file)
--- a/README
+++ b/README
@@ -75,8 +75,8 @@ REQUIREMENTS:
           CONFIG_TMPFS_XATTR
           CONFIG_SECCOMP
 
-        For systemd-bootchart a kernel with procfs support and several
-        proc output options enabled is required:
+        For systemd-bootchart, a kernel with procfs support and
+        several proc output options enabled is required:
           CONFIG_PROC_FS
           CONFIG_SCHEDSTATS
           CONFIG_SCHED_DEBUG
@@ -87,7 +87,7 @@ REQUIREMENTS:
 
         Note that kernel auditing is broken when used with systemd's
         container code. When using systemd in conjunction with
-        containers please make sure to either turn off auditing at
+        containers, please make sure to either turn off auditing at
         runtime using the kernel command line option "audit=0", or
         turn it off at kernel compile time using:
           CONFIG_AUDIT=n
@@ -110,14 +110,16 @@ REQUIREMENTS:
         libpython (optional)
         make, gcc, and similar tools
 
-        During runtime you need the following additional dependencies:
+        During runtime, you need the following additional
+        dependencies:
 
         util-linux >= v2.19 (requires fsck -l, agetty -s)
         sulogin (from util-linux >= 2.22 or sysvinit-tools, optional but recommended)
         dracut (optional)
         PolicyKit (optional)
 
-        When building from git you need the following additional dependencies:
+        When building from git, you need the following additional
+        dependencies:
 
         docbook-xsl
         xsltproc
@@ -131,16 +133,16 @@ REQUIREMENTS:
         sphinx (optional)
         python-lxml (entirely optional)
 
-        When systemd-hostnamed is used it is strongly recommended to
-        install nss-myhostname to ensure that in a world of
-        dynamically changing hostnames the hostname stays resolvable
+        When systemd-hostnamed is used, it is strongly recommended to
+        install nss-myhostname to ensure that, in a world of
+        dynamically changing hostnames, the hostname stays resolvable
         under all circumstances. In fact, systemd-hostnamed will warn
         if nss-myhostname is not installed.
 
         Note that D-Bus can link against libsystemd-login.so, which
-        results in a cyclic build dependency. To accommodate for this
-        please build D-Bus without systemd first, then build systemd,
-        then rebuild D-Bus with systemd support.
+        results in a cyclic build dependency. To accommodate for
+        this, please build D-Bus without systemd first, then build
+        systemd, then rebuild D-Bus with systemd support.
 
         To build HTML documentation for python-systemd using sphinx,
         please first install systemd (using 'make install'), and then
@@ -156,9 +158,9 @@ USERS AND GROUPS:
 
         tty, dialout, kmem, video, audio, lp, floppy, cdrom, tape, disk
 
-        During runtime the journal daemon requires the
+        During runtime, the journal daemon requires the
         "systemd-journal" system group to exist. New journal files will
-        be readable by this group (but not writable) which may be used
+        be readable by this group (but not writable), which may be used
         to grant specific users read access.
 
         It is also recommended to grant read access to all journal
@@ -180,12 +182,12 @@ WARNINGS:
 
         systemd will warn you during boot if /usr is on a different
         file system than /. While in systemd itself very little will
-        break if /usr is on a separate partition many of its
+        break if /usr is on a separate partition, many of its
         dependencies very likely will break sooner or later in one
-        form or another. For example udev rules tend to refer to
+        form or another. For example, udev rules tend to refer to
         binaries in /usr, binaries that link to libraries in /usr or
         binaries that refer to data files in /usr. Since these
-        breakages are not always directly visible systemd will warn
+        breakages are not always directly visible, systemd will warn
         about this, since this kind of file system setup is not really
         supported anymore by the basic set of Linux OS components.
 
diff --git a/TODO b/TODO
index c140098..cbb2cbe 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 Bugfixes:
 
-* enabling an instance unit creates pointless link, and
+* enabling an instance unit creates pointless link, and
   the unit will be started with getty@getty.service:
     $ systemctl enable getty@.service
     ln -s '/usr/lib/systemd/system/getty@.service' '/etc/systemd/system/getty.target.wants/getty@.service'
@@ -17,7 +17,7 @@ Bugfixes:
 
 * properly handle .mount unit state tracking when two mount points are stacked one on top of another on the exact same mount point.
 
-* When we detect invalid UTF-8, we cant't use it in an error message:
+* When we detect invalid UTF-8, we cannot use it in an error message:
   log...("Path is not UTF-8 clean, ignoring assignment: %s", rvalue);
 
 * shorten the message to sane length:
@@ -62,7 +62,7 @@ Features:
 
 * Add a new Distribute=$NUMBER key to socket units that makes use of SO_REUSEPORT to distribute network traffic on $NUMBER instances
 
-* tmpfiles: when applying ownership to /run/log/journal also do this for the journal fails contained in it
+* tmpfiles: when applying ownership to /run/log/journal, also do this for the journal fails contained in it
 
 * we probably should replace the left-over uses of strv_append() and replace them by strv_push() or strv_extend()
 
@@ -72,11 +72,11 @@ Features:
 
 * After coming back from hibernation reset hibernation swap partition using the /dev/snapshot ioctl APIs
 
-* If we try to find a unit via a dangling symlink generate a clean
-  error. Currently we just ignore it and read the unit from the search
+* If we try to find a unit via a dangling symlink, generate a clean
+  error. Currently, we just ignore it and read the unit from the search
   path anyway.
 
-* When a Type=forking service fails and needed another service that
+* When a Type=forking service fails and needed another service, that
   service is not cleaned up again when it has StopWhenUnneeded=yes
   http://lists.freedesktop.org/archives/systemd-devel/2013-July/012141.html
 
@@ -98,7 +98,7 @@ Features:
 
 * journalctl: instead --after-cursor= maybe have a --cursor=XYZ+1 syntax?
 
-* given that logind/machined now let PID 1 do all nasty work we can
+* given that logind/machined now let PID 1 do all nasty work, we can
   probably reduce the capability set they retain substantially.
 
 * btrfs raid assembly: some .device jobs stay stuck in the queue
@@ -111,9 +111,9 @@ Features:
 
 * when parsing calendar timestamps support the UTC timezone (even if we won't support arbitrary timezone specs, support UTC itself certainly makes sense), also support syntaxes such as +0200
 
-* when a kernel driver logs in a tight loop we should ratelimit that too.
+* when a kernel driver logs in a tight loop, we should ratelimit that too.
 
-* "systemctl disable" of a unit instance removes all symlinks, should
+* "systemctl disable" of a unit instance removes all symlinks, but should
   only remove the instance symlink (systemctl disable of a template
   unit however should remove them all).
 
@@ -131,7 +131,7 @@ Features:
 
 * add a fixed dbus path for "my own unit", "my own session", ... to PID1, logind, ...
 
-* service_coldplug() appears to reinstall the wrong stop timeout watch?
+* service_coldplug() appears to reinstall the wrong stop timeout watch.
 
 * transient units: allow creating auxiliary units with the same call
 
@@ -154,7 +154,7 @@ Features:
 
 * we should properly escape ssh hostnames we add into dbus server strings
 
-* something pulls in pcre as so dep into our daemons such as hostnamed.
+* something pulls in pcre as shared object dependency into our daemons such as hostnamed.
 
 * document systemd-journal-flush.service properly
 
index 612dc28..afcff7c 100644 (file)
                         <varlistentry>
                                 <term><varname>systemd.restore_state=</varname></term>
                                 <listitem>
-                                        <para>Parameter understood by
+                                        <para>This parameter is understood by
                                         several system tools to control
                                         whether or not they should restore
                                         system state from the previous boot.
index 7f7e83e..8996686 100644 (file)
@@ -62,7 +62,7 @@
                 as necessary.</para>
 
                 <para>The <varname>passno</varname> field
-                is treated like a simlpe boolean, and the ordering information
+                is treated like a simple boolean, and the ordering information
                 is discarded. However, the root filesystem is checked
                 before all the other filesystems.</para>
 
index 87122f5..9f2389a 100644 (file)
@@ -46,7 +46,7 @@
                 <cmdsynopsis>
                         <command>systemd-socket-proxyd</command>
                         <arg choice="opt" rep="repeat">OPTIONS</arg>
-                        <arg choice="plain"><replaceable>HOSTNAME-OR-IP</replaceable></arg>
+                        <arg choice="plain"><replaceable>HOSTNAME-OR-IPADDR</replaceable></arg>
                         <arg choice="plain"><replaceable>PORT-OR-SERVICE</replaceable></arg>
                 </cmdsynopsis>
                 <cmdsynopsis>
@@ -67,7 +67,7 @@
                 for each client, and then bidirectionally forwards
                 data between the two.</para>
                 <para>This utility's behavior is similar to
-                <citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum> </citerefentry>.
+                <citerefentry><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
                 The main differences for <command>systemd-socket-proxyd</command>
                 are support for socket activation with
                 <literal>Accept=false</literal> and an event-driven
@@ -98,9 +98,9 @@
                                 <listitem>
                                         <para>Skips verification of
                                         the expected PID and file
-                                        descriptor numbers. Use if
+                                        descriptor numbers. Use this if
                                         invoked indirectly, for
-                                        example with a shell script
+                                        example, with a shell script
                                         rather than with
                                         <option>ExecStart=/usr/lib/systemd/systemd-socket-proxyd</option>
                                         </para>
         </refsect1>
         <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>
         <refsect1>