Merge pull request #1420 from keszybz/doc-updates

Doc updates

7 files changed, 39 insertions, 30 deletions

diff --git a/NEWS b/NEWS
index 03dc5ba2e3..e56a922d2b 100644
--- a/NEWS
+++ b/NEWS
@@ -17,7 +17,7 @@ CHANGES WITH 227:
           It allows accounting the number of tasks in a cgroup and
           enforcing limits on it. This adds two new setting
           TasksAccounting= and TasksMax= to each unit, as well as a
-          gloabl option DefaultTasksAccounting=.
+          global option DefaultTasksAccounting=.
 
         * Support for the "net_cls" cgroup controller has been added.
           It allows assigning a net class ID to each task in the cgroup,
@@ -27,7 +27,7 @@ CHANGES WITH 227:
           sockets.
 
           This adds a new config directive called NetClass= to CGroup
-          enabled units. Allowed values are positive numbers for fix
+          enabled units. Allowed values are positive numbers for fixed
           assignments and "auto" for picking a free value
           automatically.
 
diff --git a/man/machine-id.xml b/man/machine-id.xml
index 8ce9c46ff1..db72c2a01c 100644
--- a/man/machine-id.xml
+++ b/man/machine-id.xml
@@ -119,7 +119,7 @@ id[8] = (id[8] &amp; 0x3F) | 0x80;</programlisting>
     <filename>/etc/machine-id</filename> originates in the
     <filename>/var/lib/dbus/machine-id</filename> file introduced by
     D-Bus. In fact, this latter file might be a symlink to
-    <varname>/etc/machine-id</varname>.</para>
+    <filename>/etc/machine-id</filename>.</para>
   </refsect1>
 
   <refsect1>
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 642d95a029..eeb98198ab 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -287,7 +287,7 @@
         below (see section "Command Lines" below).
         </para>
 
-        <para>When <varname>Type</varname> is not
+        <para>When <varname>Type=</varname> is not
         <option>oneshot</option>, only one command may and must be
         given. When <varname>Type=oneshot</varname> is used, zero or
         more commands may be specified. This can be specified by
@@ -421,7 +421,7 @@
         <varname>ExecStop=</varname> defined, or where the service
         exited unexpectedly. This argument takes multiple command
         lines, following the same scheme as described for
-        <varname>ExecStart</varname>. Use of these settings is
+        <varname>ExecStart=</varname>. Use of these settings is
         optional. Specifier and environment variable substitution is
         supported.</para></listitem>
       </varlistentry>
@@ -486,7 +486,7 @@
         "keep-alive ping"). If the time between two such calls is
         larger than the configured time, then the service is placed in
         a failed state and it will be terminated with
-        <varname>SIGABRT</varname>. By setting
+        <constant>SIGABRT</constant>. By setting
         <varname>Restart=</varname> to <option>on-failure</option> or
         <option>always</option>, the service will be automatically
         restarted. The time configured here will be passed to the
@@ -905,12 +905,15 @@
 
       <varlistentry>
         <term><varname>USBFunctionDescriptors=</varname></term>
-        <listitem><para>Configure the location of file containing
-        FunctionFS descriptors. This is is used only when socket with
-        <varname>ListenUSBFunction</varname> line want to activate this service. Content of
-        this file is writen to ep0 file after it is opened. This is required
-        for socket activation using <varname>ListenUSBFunction</varname>
-        (i.e. for passing all ffs endpoints to service).</para></listitem>
+        <listitem><para>Configure the location of the file containing
+        <ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
+        descriptors. This is is used only when a socket with
+        <varname>ListenUSBFunction=</varname> configured wants to
+        activate this service. Content of this file is writen to
+        <filename>ep0</filename> file after it is opened. This is
+        required for socket activation using
+        <varname>ListenUSBFunction=</varname> (i.e. for passing all
+        functionfs endpoints to the service).</para></listitem>
       </varlistentry>
 
       <varlistentry>
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 7f884aa1be..bb75b69cea 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -262,13 +262,17 @@
 
       <varlistentry>
         <term><varname>ListenUSBFunction=</varname></term>
-        <listitem><para>Specifies a functionfs endpoint location
-        to listen on. This expects an absolute file system path as
+        <listitem><para>Specifies a
+        <ulink url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">functionfs</ulink>
+        endpoint location to
+        listen on. This expects an absolute file system path as the
         argument. Behavior otherwise is very similar to the
         <varname>ListenFIFO=</varname> directive above. Use this to
-        open functionfs endpoint ep0. When using this option, activated
-        service has to have <varname>USBFunctionDescriptors</varname>
-        and <varname>USBFunctionStrings</varname> options set.</para></listitem>
+        open functionfs endpoint <filename>ep0</filename>. When using
+        this option, activated service has to have the
+        <varname>USBFunctionDescriptors=</varname> and
+        <varname>USBFunctionStrings=</varname> options set.
+        </para></listitem>
       </varlistentry>
 
       <varlistentry>
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 6e0dff9b47..78bad4d814 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -215,20 +215,19 @@
         <term><filename>exit.target</filename></term>
         <listitem>
           <para>A special service unit for shutting down the system or
-          user service manager. It also works in containers and is
-          equivalent to <filename>poweroff.target</filename> on
-          non-container systems.</para>
+          user service manager. It is equivalent to
+          <filename>poweroff.target</filename> on non-container
+          systems, and also works in containers.</para>
 
-          <para>Applications wanting to terminate the user service
-          manager should start this unit. If systemd receives
+          <para>systemd will start this unit when it receives a
+          request to shut down over D-Bus or a
           <constant>SIGTERM</constant> or <constant>SIGINT</constant>
-          when running as user service daemon, it will start this
-          unit.</para>
+          signal when running as user service daemon.</para>
 
-          <para>Normally, this pulls in
+          <para>Normally, this (indirectly) pulls in
           <filename>shutdown.target</filename> which in turn should be
-          conflicted by all units that want to be shut down on user
-          service manager exit.</para>
+          conflicted by all units that want to be scheduled for
+          shutdown when the service manager starts to exit.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 015deab4bb..8985b6b940 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -1055,8 +1055,11 @@
         <literal>auto</literal> (for dynamic allocation). Network traffic of
         all processes inside the unit will have the network class ID assigned
         by the kernel. Also see
-        <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-        .</para></listitem>
+        the kernel docs for
+        <ulink url="https://www.kernel.org/doc/Documentation/cgroups/net_cls.txt">net_cls controller</ulink>
+        and
+        <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+        </para></listitem>
       </varlistentry>
     </variablelist>
 
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 9a86c4126a..c439bc56ed 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -178,7 +178,7 @@
         protected by a different access policy.</para>
 
         <para>Note that even if time synchronization is turned off
-        with this command another, unrelated system service might
+        with this command, another unrelated system service might
         still synchronize the clock with the network. Also note that
         strictly speaking
         <filename>systemd-timesyncd.service</filename> does more than