doc: use expanded forms for written style

This commit is contained in:
Jan Engelhardt 2015-10-26 15:45:12 +01:00
parent a8eaaee72a
commit 7ca4155737
20 changed files with 21 additions and 21 deletions

View File

@ -904,7 +904,7 @@
refers to the image of the running host system. It hence refers to the image of the running host system. It hence
conceptually maps to the special <literal>.host</literal> machine conceptually maps to the special <literal>.host</literal> machine
name described above. Note that <command>machinectl name described above. Note that <command>machinectl
list-images</command> won't show this special image either, unless list-images</command> will not show this special image either, unless
<option>--all</option> is specified.</para> <option>--all</option> is specified.</para>
</refsect1> </refsect1>

View File

@ -108,7 +108,7 @@
<refsect1> <refsect1>
<title>Example</title> <title>Example</title>
<para>Here's an example <filename>/etc/nsswitch.conf</filename> <para>Here is an example <filename>/etc/nsswitch.conf</filename>
file that enables <command>myhostname</command> correctly:</para> file that enables <command>myhostname</command> correctly:</para>
<programlisting>passwd: compat mymachines <programlisting>passwd: compat mymachines

View File

@ -84,7 +84,7 @@
<refsect1> <refsect1>
<title>Example</title> <title>Example</title>
<para>Here's an example <filename>/etc/nsswitch.conf</filename> <para>Here is an example <filename>/etc/nsswitch.conf</filename>
file that enables <command>mymachines</command> correctly:</para> file that enables <command>mymachines</command> correctly:</para>
<programlisting>passwd: compat <command>mymachines</command> <programlisting>passwd: compat <command>mymachines</command>

View File

@ -79,7 +79,7 @@
<refsect1> <refsect1>
<title>Example</title> <title>Example</title>
<para>Here's an example <filename>/etc/nsswitch.conf</filename> <para>Here is an example <filename>/etc/nsswitch.conf</filename>
file that enables <command>resolve</command> correctly:</para> file that enables <command>resolve</command> correctly:</para>
<programlisting>passwd: compat mymachines <programlisting>passwd: compat mymachines

View File

@ -131,7 +131,7 @@
<parameter>type</parameter>. However, as a special exception, if <parameter>type</parameter>. However, as a special exception, if
the offset is specified as zero and the size specified as the offset is specified as zero and the size specified as
UINT64_MAX the full memory file descriptor contents is used. The UINT64_MAX the full memory file descriptor contents is used. The
memory file descriptor is sealed by this call if it hasn't been memory file descriptor is sealed by this call if it has not been
sealed yet, and cannot be modified after this call. See sealed yet, and cannot be modified after this call. See
<citerefentry <citerefentry
project='man-pages'><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry> project='man-pages'><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>

View File

@ -84,7 +84,7 @@
or a related call, and then start the connection with or a related call, and then start the connection with
<citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>In most cases, it's a better idea to invoke <para>In most cases, it is a better idea to invoke
<citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>
or related calls instead of the more low-level or related calls instead of the more low-level

View File

@ -127,7 +127,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted).</para></listitem> or NULL, where that is not accepted).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -187,7 +187,7 @@ else {
certain latency. This call will return a positive value if the certain latency. This call will return a positive value if the
journal changes are detected immediately and zero when they need journal changes are detected immediately and zero when they need
to be polled for and hence might be noticed only with a certain to be polled for and hence might be noticed only with a certain
latency. Note that there's usually no need to invoke this function latency. Note that there is usually no need to invoke this function
directly as <function>sd_journal_get_timeout()</function> on these directly as <function>sd_journal_get_timeout()</function> on these
file systems will ask for timeouts explicitly anyway.</para> file systems will ask for timeouts explicitly anyway.</para>
</refsect1> </refsect1>

View File

@ -214,7 +214,7 @@ else {
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted). The specified category to or NULL, where that is not accepted). The specified category to
watch is not known.</para></listitem> watch is not known.</para></listitem>
</varlistentry> </varlistentry>

View File

@ -116,7 +116,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted).</para></listitem> or NULL, where that is not accepted).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -303,7 +303,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted).</para></listitem> or NULL, where that is not accepted).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -174,7 +174,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted).</para></listitem> or NULL, where that is not accepted).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -315,7 +315,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted).</para></listitem> or NULL, where that is not accepted).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

View File

@ -195,7 +195,7 @@
<term><constant>-EINVAL</constant></term> <term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range, <listitem><para>An input parameter was invalid (out of range,
or NULL, where that's not accepted). This is also returned if or NULL, where that is not accepted). This is also returned if
the passed user ID is 0xFFFF or 0xFFFFFFFF, which are the passed user ID is 0xFFFF or 0xFFFFFFFF, which are
undefined on Linux.</para></listitem> undefined on Linux.</para></listitem>
</varlistentry> </varlistentry>

View File

@ -62,7 +62,7 @@
device that is configured for file system checking. device that is configured for file system checking.
<filename>systemd-fsck-root.service</filename> is responsible for <filename>systemd-fsck-root.service</filename> is responsible for
file system checks on the root file system, but only if the file system checks on the root file system, but only if the
root filesystem wasn't checked in the initramfs. root filesystem was not checked in the initramfs.
<filename>systemd-fsck@.service</filename> is used for all other <filename>systemd-fsck@.service</filename> is used for all other
file systems and for the root file system in the initramfs.</para> file systems and for the root file system in the initramfs.</para>

View File

@ -66,7 +66,7 @@
their current values is shown. When at least one argument is their current values is shown. When at least one argument is
passed, the path with this name is queried and its value shown. passed, the path with this name is queried and its value shown.
The variables whose name begins with <literal>search-</literal> The variables whose name begins with <literal>search-</literal>
don't refer to individual paths, but instead to a list of do not refer to individual paths, but instead to a list of
colon-separated search paths, in their order of precedence.</para> colon-separated search paths, in their order of precedence.</para>
</refsect1> </refsect1>

View File

@ -269,7 +269,7 @@
<para> <para>
Instead of heading off now and writing all kind of Instead of heading off now and writing all kind of
generators for legacy configuration file formats, please generators for legacy configuration file formats, please
think twice! It's often a better idea to just deprecate think twice! It is often a better idea to just deprecate
old stuff instead of keeping it artificially alive. old stuff instead of keeping it artificially alive.
</para> </para>
</listitem> </listitem>

View File

@ -1324,7 +1324,7 @@ ExecStart=/usr/sbin/simple-dbus-service
[Install] [Install]
WantedBy=multi-user.target</programlisting> WantedBy=multi-user.target</programlisting>
<para>For <emphasis>bus-activatable</emphasis> services, don't <para>For <emphasis>bus-activatable</emphasis> services, do not
include a <literal>[Install]</literal> section in the systemd include a <literal>[Install]</literal> section in the systemd
service file, but use the <varname>SystemdService=</varname> service file, but use the <varname>SystemdService=</varname>
option in the corresponding DBus service file, for example option in the corresponding DBus service file, for example
@ -1366,7 +1366,7 @@ ExecStart=/usr/sbin/simple-notifying-service
WantedBy=multi-user.target</programlisting> WantedBy=multi-user.target</programlisting>
<para>Note that the daemon has to support systemd's notification <para>Note that the daemon has to support systemd's notification
protocol, else systemd will think the service hasn't started yet protocol, else systemd will think the service has not started yet
and kill it after a timeout. For an example of how to update and kill it after a timeout. For an example of how to update
daemons to support this protocol transparently, take a look at daemons to support this protocol transparently, take a look at
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>. <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.

View File

@ -443,7 +443,7 @@
<varlistentry> <varlistentry>
<term><varname>KeepAliveProbes=</varname></term> <term><varname>KeepAliveProbes=</varname></term>
<listitem><para>Takes an integer as argument. It's the number of <listitem><para>Takes an integer as argument. It is the number of
unacknowledged probes to send before considering the unacknowledged probes to send before considering the
connection dead and notifying the application layer. This connection dead and notifying the application layer. This
controls the TCP_KEEPCNT socket option (see controls the TCP_KEEPCNT socket option (see

View File

@ -779,7 +779,7 @@
<term><varname>ConditionFileNotEmpty=</varname></term> <term><varname>ConditionFileNotEmpty=</varname></term>
<term><varname>ConditionFileIsExecutable=</varname></term> <term><varname>ConditionFileIsExecutable=</varname></term>
<!-- We don't document ConditionNull= <!-- We do not document ConditionNull=
here, as it is not particularly here, as it is not particularly
useful and probably just useful and probably just
confusing. --> confusing. -->