shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-02-22 17:57:49 +03:00
Code

man: make separate "Errors" sections subsection of "Return value"

Browse Source 
Logically, this is better, because we're describing a subset of possible
return values. Visually this also looks quite good because groff renders
refsect2 much less prominently.

Also rewrap things, add <constant> in various places, fix some typos.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2019-03-21 14:53:00 +01:00
parent 6d99c5d1d9
commit b1de39dec8
74 changed files with 1572 additions and 1650 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/sd_bus_attach_event.xml
View File

@ -84,9 +84,8 @@
0 or a positive integer. On failure, they return a negative errno-style error code.</para>
<para><function>sd_bus_get_event()</function> returns an event loop object or <constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -98,6 +97,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_close.xml
View File

@ -66,9 +66,8 @@
<para>On success, <function>sd_bus_flush()</function> returns 0 or a positive integer. On failure, it returns a
negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -80,6 +79,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

43
man/sd_bus_creds_get_pid.xml
View File

@ -455,9 +455,8 @@
<para>On success, these calls return 0 or a positive integer. On
failure, these calls return a negative errno-style error code.
</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -466,43 +465,34 @@
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>The given field is not available in the
credentials object <parameter>c</parameter>.</para>
<listitem><para>The given field is not available in the credentials object
<parameter>c</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>-ENXIO</constant></term>
<listitem><para>The given field is not specified for the described
process or peer. This will be returned by
<function>sd_bus_creds_get_unit()</function>,
<function>sd_bus_creds_get_slice()</function>,
<function>sd_bus_creds_get_user_unit()</function>,
<listitem><para>The given field is not specified for the described process or peer. This will be
returned by <function>sd_bus_creds_get_unit()</function>,
<function>sd_bus_creds_get_slice()</function>, <function>sd_bus_creds_get_user_unit()</function>,
<function>sd_bus_creds_get_user_slice()</function>, and
<function>sd_bus_creds_get_session()</function> if the process is
not part of a systemd system unit, systemd user unit, systemd
slice, or logind session. It will be returned by
<function>sd_bus_creds_get_owner_uid()</function> if the process is
not part of a systemd user unit or logind session. It will also be
returned by <function>sd_bus_creds_get_exe()</function> and
<function>sd_bus_creds_get_cmdline()</function> for kernel
threads (since these are not started from an executable binary,
nor have a command line), and by
<function>sd_bus_creds_get_session()</function> if the process is not part of a systemd system
unit, systemd user unit, systemd slice, or logind session. It will be returned by
<function>sd_bus_creds_get_owner_uid()</function> if the process is not part of a systemd user unit
or logind session. It will also be returned by <function>sd_bus_creds_get_exe()</function> and
<function>sd_bus_creds_get_cmdline()</function> for kernel threads (since these are not started
from an executable binary, nor have a command line), and by
<function>sd_bus_creds_get_audit_session_id()</function> and
<function>sd_bus_creds_get_audit_login_uid()</function> when
the process is not part of an audit session, and
<function>sd_bus_creds_get_tty()</function> if the process has
no controlling TTY.
</para>
</listitem>
<function>sd_bus_creds_get_audit_login_uid()</function> when the process is not part of an audit
session, and <function>sd_bus_creds_get_tty()</function> if the process has no controlling
TTY.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>Specified pointer parameter is <constant>NULL</constant>.
</para></listitem>
<listitem><para>Specified pointer parameter is <constant>NULL</constant>.</para></listitem>
</varlistentry>
<varlistentry>
@ -511,6 +501,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

10
man/sd_bus_creds_new_from_pid.xml
View File

@ -261,9 +261,8 @@
not needed anymore, this reference should be destroyed with
<citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -273,15 +272,13 @@
<varlistentry>
<term><constant>-ESRCH</constant></term>
<listitem><para>Specified <parameter>pid</parameter> could not
be found.</para></listitem>
<listitem><para>Specified <parameter>pid</parameter> could not be found.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>Specified parameter is invalid
(<constant>NULL</constant> in case of output
<listitem><para>Specified parameter is invalid (<constant>NULL</constant> in case of output
parameters).</para></listitem>
</varlistentry>
@ -297,6 +294,7 @@
<listitem><para>One of the requested fields is unknown to the local system.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

11
man/sd_bus_default.xml
View File

@ -269,9 +269,8 @@
<para>On success, these calls return 0 or a positive
integer. On failure, these calls return a negative
errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -293,12 +292,14 @@
<varlistentry>
<term><constant>-ESOCKTNOSUPPORT</constant></term>
<listitem><para>The protocol version required to connect to the selected bus is not supported.</para></listitem>
<listitem><para>The protocol version required to connect to the selected bus is not
supported.</para></listitem>
</varlistentry>
</variablelist>
<para>In addition, any further connection-related errors may be
by returned. See <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
<para>In addition, any further connection-related errors may be by returned. See
<citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

9
man/sd_bus_error.xml
View File

@ -325,9 +325,8 @@
project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
the memory held by the structure itself after freeing its contents
with <function>sd_bus_error_free()</function>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -337,9 +336,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>Error was already set in
<structname>sd_bus_error</structname> structure when one the
error-setting functions was called.</para></listitem>
<listitem><para>Error was already set in <structname>sd_bus_error</structname> structure when one
the error-setting functions was called.</para></listitem>
</varlistentry>
<varlistentry>
@ -348,6 +346,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_error_add_map.xml
View File

@ -98,9 +98,8 @@
tables. It returns zero when the same array was already added
before. On error, a negative <varname>errno</varname>-style error
code is returned. See below for known error codes.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -119,6 +118,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_get_fd.xml
View File

@ -104,9 +104,8 @@
<para><function>sd_bus_get_timeout()</function> returns zero or positive on success, or a negative
<varname>errno</varname>-style error code on error.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -121,8 +120,8 @@
<varlistentry>
<term><constant>-ECHILD</constant></term>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
after <function>fork()</function>.</para></listitem>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child
process after <function>fork()</function>.</para></listitem>
</varlistentry>
<varlistentry>
@ -139,6 +138,7 @@
return.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_get_n_queued_read.xml
View File

@ -68,9 +68,8 @@
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -83,6 +82,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

4
man/sd_bus_is_open.xml
View File

@ -70,9 +70,8 @@
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -84,6 +83,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

5
man/sd_bus_message_append.xml
View File

@ -227,12 +227,11 @@ sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting>
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive
integer. On failure, these functions return a negative
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
</refsect1>
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

6
man/sd_bus_message_append_array.xml
View File

@ -154,11 +154,11 @@
<refsect1>
<title>Return Value</title>
<para>On success, these calls return 0 or a positive integer. On
failure, they return a negative errno-style error code.</para>
</refsect1>
<para>On success, these calls return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_append_basic.xml
View File

@ -199,9 +199,8 @@
<para>On success, this call returns 0 or a positive integer. On
failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2 id='errors'>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -242,6 +241,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

6
man/sd_bus_message_append_string_memfd.xml
View File

@ -97,11 +97,11 @@
<refsect1>
<title>Return Value</title>
<para>On success, those calls return 0 or a positive integer. On
failure, they returns a negative errno-style error code.</para>
</refsect1>
<para>On success, those calls return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

6
man/sd_bus_message_append_strv.xml
View File

@ -58,11 +58,11 @@
<refsect1>
<title>Return Value</title>
<para>On success, this call returns 0 or a positive integer. On
failure, a negative errno-style error code is returned.</para>
</refsect1>
<para>On success, this call returns 0 or a positive integer. On failure, a negative errno-style error
code is returned.</para>
<xi:include href="sd_bus_message_append_basic.xml" xpointer="errors" />
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

9
man/sd_bus_message_copy.xml
View File

@ -51,9 +51,8 @@
<para>On success, this call returns true if anything was copied, and false if
there was nothing to copy. On failure, it returns a negative errno-style error
code.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2 id='errors'>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -70,9 +69,8 @@
<varlistentry>
<term><constant>-EPERM</constant></term>
<listitem><para>Message <parameter>m</parameter> has been sealed or
<parameter>source</parameter> has <emphasis>not</emphasis> been sealed.
</para></listitem>
<listitem><para>Message <parameter>m</parameter> has been sealed or <parameter>source</parameter>
has <emphasis>not</emphasis> been sealed. </para></listitem>
</varlistentry>
<varlistentry>
@ -95,6 +93,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

24
man/sd_bus_message_get_cookie.xml
View File

@ -63,15 +63,13 @@
<refsect1>
<title>Return Value</title>
<para>On success, these calls return 0 or a positive integer. On
failure, these calls return a negative errno-style error
code.</para>
<para>On success, these calls return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<para>On success, the cookie/reply cookie is returned in the
specified 64-bit unsigned integer variable.</para>
</refsect1>
<para>On success, the cookie/reply cookie is returned in the specified 64-bit unsigned integer
variable.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -80,20 +78,18 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>A specified parameter
is invalid.</para></listitem>
<listitem><para>A specified parameter is invalid.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>No cookie has been assigned to this message.
This either indicates that the message has not been sent yet
and hence has no cookie assigned, or that the message is not a
method response message and hence carries a reply cookie
field.</para></listitem>
<listitem><para>No cookie has been assigned to this message. This either indicates that the
message has not been sent yet and hence has no cookie assigned, or that the message is not a method
response message and hence carries a reply cookie field.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

15
man/sd_bus_message_get_monotonic_usec.xml
View File

@ -98,9 +98,8 @@
<para>On success, the timestamp or sequence number is returned in
the specified 64-bit unsigned integer variable.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -109,21 +108,19 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>A specified parameter is
invalid.</para></listitem>
<listitem><para>A specified parameter is invalid.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>No timestamp or sequence number information is
attached to the passed message. This error is returned if the
underlying transport does not support timestamping or
assigning of sequence numbers, or if this feature has not been
negotiated with
<listitem><para>No timestamp or sequence number information is attached to the passed message. This
error is returned if the underlying transport does not support timestamping or assigning of
sequence numbers, or if this feature has not been negotiated with
<citerefentry><refentrytitle>sd_bus_negotiate_timestamp</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_get_signature.xml
View File

@ -72,9 +72,8 @@
<para>The other functions return 0 or a positive integer on success. On failure, they return a
negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -94,6 +93,7 @@
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_get_type.xml
View File

@ -96,9 +96,8 @@
<para>On success, those functions return 0 or a positive
integer. On failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -111,6 +110,7 @@
<constant>NULL</constant>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_new.xml
View File

@ -141,9 +141,8 @@
<constant>NULL</constant>.</para>
<para><function>sd_bus_message_get_bus()</function> always returns the bus object.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -168,6 +167,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_new_method_call.xml
View File

@ -82,9 +82,8 @@
<para>This function returns 0 if the message object was successfully created, and a negative
errno-style error code otherwise.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2 id='errors'>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -136,6 +135,7 @@
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_new_method_error.xml
View File

@ -127,9 +127,8 @@
<para>These functions return 0 if the error reply was successfully created, and a
negative errno-style error code otherwise.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2 id='errors'>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -171,6 +170,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_new_signal.xml
View File

@ -56,9 +56,8 @@
<para>This function returns 0 if the message object was successfully created, and a negative
errno-style error code otherwise.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -90,6 +89,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

10
man/sd_bus_message_read.xml
View File

@ -154,14 +154,12 @@
<refsect1>
<title>Return Value</title>
<para>
On success, <function>sd_bus_message_read()</function> and
<function>sd_bus_message_readv()</function> return 0 or a positive integer. On
failure, they return a negative errno-style error code.
</para>
</refsect1>
<para>On success, <function>sd_bus_message_read()</function> and
<function>sd_bus_message_readv()</function> return 0 or a positive integer. On failure, they return a
negative errno-style error code.</para>
<xi:include href="sd_bus_message_read_basic.xml" xpointer="errors" />
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_read_array.xml
View File

@ -58,9 +58,8 @@
a positive integer. On failure, it returns a negative errno-style error
code.
</para>
</refsect1>
<refsect1 id='errors'>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -93,6 +92,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

8
man/sd_bus_message_read_basic.xml
View File

@ -190,9 +190,8 @@
a positive integer. On failure, it returns a negative errno-style error
code.
</para>
</refsect1>
<refsect1 id='errors'>
<refsect2 id='errors'>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -208,8 +207,8 @@
<varlistentry>
<term><constant>-ENXIO</constant></term>
<listitem><para>The message does not contain the specified type at current
position.</para></listitem>
<listitem><para>The message does not contain the specified type at current position.
</para></listitem>
</varlistentry>
<varlistentry>
@ -218,6 +217,7 @@
<listitem><para>The message cannot be parsed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

8
man/sd_bus_message_rewind.xml
View File

@ -51,11 +51,8 @@
container or whole message in case no container is open is empty, and positive otherwise. On
failure, it returns a negative errno-style error code.
</para>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -73,8 +70,11 @@
<listitem><para>The message <parameter>m</parameter> has not been sealed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />
<refsect1>
<title>See Also</title>

4
man/sd_bus_message_set_destination.xml
View File

@ -106,9 +106,8 @@
<para>On success, these calls return 0 or a positive integer. On failure, these calls return a
negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -135,6 +134,7 @@
<listitem><para>The message already has a destination or sender field set.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_set_expect_reply.xml
View File

@ -84,9 +84,8 @@
<para>On success, these functions return 0 or a positive integer. On failure, they return a
negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -110,6 +109,7 @@
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_skip.xml
View File

@ -50,9 +50,8 @@
<para>On success, <function>sd_bus_message_skip()</function> returns 0 or a positive integer. On
failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -90,6 +89,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_message_verify_type.xml
View File

@ -56,9 +56,8 @@
<para>On success, this call returns true if the type matches and zero if not (the message
<parameter>m</parameter> contains different data or the end of the message has been reached). On
failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -82,6 +81,7 @@
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_negotiate_fds.xml
View File

@ -108,9 +108,8 @@
<para>On success, these functions return 0 or a
positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -122,6 +121,7 @@
<listitem><para>The bus connection has already been started.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_new.xml
View File

@ -166,9 +166,8 @@
<para><function>sd_bus_unref()</function> and <function>sd_bus_flush_close_unref()</function> always return
<constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -180,6 +179,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

16
man/sd_bus_process.xml
View File

@ -69,11 +69,10 @@
<refsect1>
<title>Return Value</title>
<para>If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an error
occurs, a negative <varname>errno</varname>-style error code is returned.</para>
</refsect1>
<para>If progress was made, a positive integer is returned. If no progress was made, 0 is returned. If an
error occurs, a negative <varname>errno</varname>-style error code is returned.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -88,8 +87,8 @@
<varlistentry>
<term><constant>-ECHILD</constant></term>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
after <function>fork()</function>.</para></listitem>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child
process after <function>fork()</function>.</para></listitem>
</varlistentry>
<varlistentry>
@ -107,11 +106,12 @@
<varlistentry>
<term><constant>-EBUSY</constant></term>
<listitem><para>This function is already being called, i.e. <function>sd_bus_process()</function> has been
called from a callback function that itself was called by
<listitem><para>This function is already being called, i.e. <function>sd_bus_process()</function>
has been called from a callback function that itself was called by
<function>sd_bus_process()</function>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_reply_method_error.xml
View File

@ -91,9 +91,8 @@
<para>These functions return 0 if the error reply was successfully sent or if
none was expected, and a negative errno-style error code otherwise.</para>
</refsect1>
<refsect1 id='errors'>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -127,8 +126,8 @@
<varlistentry>
<term><constant>-ENOTCONN</constant></term>
<listitem><para>The bus to which message <parameter>call</parameter> is
attached is not connected.</para></listitem>
<listitem><para>The bus to which message <parameter>call</parameter> is attached is not
connected.</para></listitem>
</varlistentry>
<varlistentry>
@ -141,6 +140,7 @@
<para>In addition, any error message returned by
<citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>1</manvolnum></citerefentry>
may be returned.</para>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

10
man/sd_bus_request_name.xml
View File

@ -132,9 +132,8 @@
case, the caller can subscribe to <literal>NameOwnerChanged</literal> signals to be notified when the name is
successfully acquired. <function>sd_bus_request_name()</function> returns &gt; 0 when the name has immediately
been acquired successfully.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -171,9 +170,9 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>A specified parameter is invalid. This is also generated when the requested name is a special
service name reserved by the D-Bus specification, or when the operation is requested on a connection that does
not refer to a bus.</para></listitem>
<listitem><para>A specified parameter is invalid. This is also generated when the requested name is
a special service name reserved by the D-Bus specification, or when the operation is requested on a
connection that does not refer to a bus.</para></listitem>
</varlistentry>
<varlistentry>
@ -189,6 +188,7 @@
one.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_set_close_on_exit.xml
View File

@ -68,9 +68,8 @@
<para><function>sd_bus_get_close_on_exit()</function> returns 0 if the feature is currently turned off or a
positive integer if it is on. On failure, it returns a negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -82,6 +81,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_set_connected_signal.xml
View File

@ -74,11 +74,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -90,6 +89,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_set_description.xml
View File

@ -116,11 +116,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer. On failure,
they return a negative errno-style error code.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -165,6 +164,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

11
man/sd_bus_set_sender.xml
View File

@ -63,11 +63,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -82,9 +81,11 @@
<varlistentry>
<term><constant>-EPERM</constant></term>
<listitem><para>The specified bus connection object is a not a direct but a brokered connection.</para></listitem>
<listitem><para>The specified bus connection object is a not a direct but a brokered
connection.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_set_watch_bind.xml
View File

@ -80,11 +80,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -96,6 +95,7 @@
<listitem><para>The bus connection has been created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_bus_slot_set_description.xml
View File

@ -60,9 +60,8 @@
<para>On success, these functions return 0 or a positive integer. On failure,
they return a negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -91,6 +90,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

12
man/sd_bus_slot_set_destroy_callback.xml
View File

@ -88,15 +88,14 @@
<title>Return Value</title>
<para>On success, <function>sd_bus_slot_set_destroy_callback()</function> and
<function>sd_bus_track_set_destroy_callback()</function> return 0 or a positive integer. On failure, they return a
negative errno-style error code.</para>
<function>sd_bus_track_set_destroy_callback()</function> return 0 or a positive integer. On failure, they
return a negative errno-style error code.</para>
<para><function>sd_bus_slot_get_destroy_callback()</function> and
<function>sd_bus_track_get_destroy_callback()</function> return positive if the destroy callback function is set, 0
if not. On failure, they return a negative errno-style error code.</para>
</refsect1>
<function>sd_bus_track_get_destroy_callback()</function> return positive if the destroy callback function
is set, 0 if not. On failure, they return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -109,6 +108,7 @@
<constant>NULL</constant>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

12
man/sd_bus_slot_set_floating.xml
View File

@ -70,11 +70,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -95,10 +94,11 @@
<varlistentry>
<term><constant>-ESTALE</constant></term>
<listitem><para>The bus object the specified bus slot object is associated with has already been freed, and
hence no change in the floating state can be made anymore.</para></listitem>
<listitem><para>The bus object the specified bus slot object is associated with has already been
freed, and hence no change in the floating state can be made anymore.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_track_add_name.xml
View File

@ -181,9 +181,8 @@
<para><function>sd_bus_track_first()</function> and <function>sd_bus_track_next()</function> return the first/next
name contained in the bus peer tracking object, and <constant>NULL</constant> if the end of the enumeration is
reached and on error.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -194,8 +193,8 @@
<term><constant>-EUNATCH</constant></term>
<listitem><para><function>sd_bus_track_remove_name()</function> or
<function>sd_bus_track_remove_sender()</function> have been invoked for a name not previously added to the bus
peer object.</para></listitem>
<function>sd_bus_track_remove_sender()</function> have been invoked for a name not previously added
to the bus peer object.</para></listitem>
</varlistentry>
<varlistentry>
@ -211,6 +210,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

7
man/sd_bus_track_new.xml
View File

@ -182,9 +182,8 @@
reference. When not needed anymore, this reference should be destroyed with
<function>sd_bus_track_unref()</function>.
</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -195,7 +194,8 @@
<term><constant>-EBUSY</constant></term>
<listitem><para>Bus peers have already been added to the bus peer tracking object and
<function>sd_bus_track_set_recursive()</function> was called to change tracking mode.</para></listitem>
<function>sd_bus_track_set_recursive()</function> was called to change tracking mode.
</para></listitem>
</varlistentry>
<varlistentry>
@ -213,6 +213,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_bus_wait.xml
View File

@ -66,9 +66,8 @@
<para>If any I/O was seen, a positive value is returned, zero otherwise. If an error occurs, a negative
<varname>errno</varname>-style error code is returned.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -83,8 +82,8 @@
<varlistentry>
<term><constant>-ECHILD</constant></term>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child process
after <function>fork()</function>.</para></listitem>
<listitem><para>The bus connection was allocated in a parent process and is being reused in a child
process after <function>fork()</function>.</para></listitem>
</varlistentry>
<varlistentry>
@ -93,6 +92,7 @@
<listitem><para>The bus connection has been terminated already.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_event_add_child.xml
View File

@ -137,9 +137,8 @@
<para>On success, these functions return 0 or a positive
integer. On failure, they return a negative errno-style error
code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -192,6 +191,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_event_add_defer.xml
View File

@ -129,9 +129,8 @@
<para>On success, these functions return 0 or a positive
integer. On failure, they return a negative errno-style error
code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -162,6 +161,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_event_add_inotify.xml
View File

@ -110,9 +110,8 @@
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative errno-style
error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -152,6 +151,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

4
man/sd_event_add_io.xml
View File

@ -228,9 +228,8 @@
<para>On success, these functions return 0 or a positive
integer. On failure, they return a negative errno-style error
code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned values may indicate the following problems:</para>
@ -268,6 +267,7 @@
<listitem><para>The passed event source is not an I/O event source.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_event_add_signal.xml
View File

@ -121,9 +121,8 @@
<para>On success, these functions return 0 or a positive
integer. On failure, they return a negative errno-style error
code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -167,6 +166,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

4
man/sd_event_add_time.xml
View File

@ -209,9 +209,8 @@
<para>On success, these functions return 0 or a positive
integer. On failure, they return a negative errno-style error
code. </para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned values may indicate the following problems:</para>
@ -257,6 +256,7 @@
<listitem><para>The passed event source is not a timer event source.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

13
man/sd_event_exit.xml
View File

@ -79,13 +79,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_event_exit()</function> and
<function>sd_event_get_exit_code()</function> return 0 or a positive
integer. On failure, they return a negative errno-style error
code.</para>
</refsect1>
<para>On success, <function>sd_event_exit()</function> and <function>sd_event_get_exit_code()</function>
return 0 or a positive integer. On failure, they return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -108,7 +105,8 @@
<varlistentry>
<term><constant>-ESTALE</constant></term>
<listitem><para>The event loop has exited already and all exit handlers are already processed.</para></listitem>
<listitem><para>The event loop has exited already and all exit handlers are already processed.
</para></listitem>
</varlistentry>
<varlistentry>
@ -118,6 +116,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

14
man/sd_event_get_fd.xml
View File

@ -58,12 +58,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_event_get_fd()</function> returns a
non-negative file descriptor. On failure, it returns a negative
errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_event_get_fd()</function> returns a non-negative file descriptor. On
failure, it returns a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -72,9 +70,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>event</parameter> is not a valid
pointer to an <structname>sd_event</structname> structure.
</para></listitem>
<listitem><para><parameter>event</parameter> is not a valid pointer to an
<structname>sd_event</structname> structure.</para></listitem>
</varlistentry>
<varlistentry>
@ -84,6 +81,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

20
man/sd_event_new.xml
View File

@ -158,17 +158,13 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_event_new()</function>,
<function>sd_event_default()</function> and
<function>sd_event_get_tid()</function> return 0 or a positive
integer. On failure, they return a negative errno-style error
code. <function>sd_event_ref()</function> always returns a pointer
to the event loop object passed
in. <function>sd_event_unref()</function> always returns
<para>On success, <function>sd_event_new()</function>, <function>sd_event_default()</function> and
<function>sd_event_get_tid()</function> return 0 or a positive integer. On failure, they return a
negative errno-style error code. <function>sd_event_ref()</function> always returns a pointer to the
event loop object passed in. <function>sd_event_unref()</function> always returns
<constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -190,12 +186,12 @@
<varlistentry>
<term><constant>-ENXIO</constant></term>
<listitem><para><function>sd_event_get_tid()</function> was
invoked on an event loop object that was not allocated with
<function>sd_event_default()</function>.</para></listitem>
<listitem><para><function>sd_event_get_tid()</function> was invoked on an event loop object that
was not allocated with <function>sd_event_default()</function>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

23
man/sd_event_now.xml
View File

@ -64,15 +64,12 @@
<refsect1>
<title>Return Value</title>
<para>If the first event loop iteration has not run yet
<function>sd_event_now()</function> writes current time to
<parameter>usec</parameter> and returns a positive return value.
Otherwise, it will write the requested timestamp to <parameter>usec</parameter>
and return 0. On failure, the call returns a negative errno-style
error code.</para>
</refsect1>
<para>If the first event loop iteration has not run yet <function>sd_event_now()</function> writes
current time to <parameter>usec</parameter> and returns a positive return value. Otherwise, it will
write the requested timestamp to <parameter>usec</parameter> and return 0. On failure, the call returns a
negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned values may indicate the following problems:</para>
@ -81,25 +78,23 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An invalid parameter was
passed.</para></listitem>
<listitem><para>An invalid parameter was passed.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-EOPNOTSUPP</constant></term>
<listitem><para>Unsupported clock type.
</para></listitem>
<listitem><para>Unsupported clock type.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-ECHILD</constant></term>
<listitem><para>The event loop object was created in a
different process.</para></listitem>
<listitem><para>The event loop object was created in a different process.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

8
man/sd_event_run.xml
View File

@ -96,9 +96,8 @@
dispatched. <function>sd_event_loop()</function> returns the exit
code specified when invoking
<function>sd_event_exit()</function>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -107,8 +106,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>The <parameter>event</parameter> parameter is
invalid or <constant>NULL</constant>.</para></listitem>
<listitem><para>The <parameter>event</parameter> parameter is invalid or
<constant>NULL</constant>.</para></listitem>
</varlistentry>
<varlistentry>
@ -137,6 +136,7 @@
</variablelist>
<para>Other errors are possible, too.</para>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

16
man/sd_event_set_watchdog.xml
View File

@ -93,17 +93,12 @@
<title>Return Value</title>
<para>On success, <function>sd_event_set_watchdog()</function> and
<function>sd_event_get_watchdog()</function> return a non-zero
positive integer if the service manager requested watchdog support
and watchdog support was successfully enabled. They return zero if
the service manager did not request watchdog support, or if
watchdog support was explicitly disabled with a false
<parameter>b</parameter> parameter. On failure, they return a
negative errno-style error
code.</para>
</refsect1>
<function>sd_event_get_watchdog()</function> return a non-zero positive integer if the service manager
requested watchdog support and watchdog support was successfully enabled. They return zero if the service
manager did not request watchdog support, or if watchdog support was explicitly disabled with a false
<parameter>b</parameter> parameter. On failure, they return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -123,6 +118,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

20
man/sd_event_source_get_pending.xml
View File

@ -69,14 +69,11 @@
<refsect1>
<title>Return Value</title>
<para>On success,
<function>sd_event_source_get_pending()</function> returns an
integer greater than zero when the event source is marked pending,
and zero when the event source is not marked pending. On failure,
it returns a negative errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_event_source_get_pending()</function> returns an integer greater than zero
when the event source is marked pending, and zero when the event source is not marked pending. On
failure, it returns a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -85,16 +82,14 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>source</parameter> is not a valid
pointer to an <structname>sd_event_source</structname>
object.</para></listitem>
<listitem><para><parameter>source</parameter> is not a valid pointer to an
<structname>sd_event_source</structname> object.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-EDOM</constant></term>
<listitem><para><parameter>source</parameter> refers to an
event source object created with
<listitem><para><parameter>source</parameter> refers to an event source object created with
<citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
@ -119,6 +114,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

24
man/sd_event_source_set_description.xml
View File

@ -79,12 +79,10 @@
<title>Return Value</title>
<para>On success, <function>sd_event_source_set_description()</function> and
<function>sd_event_source_get_description()</function> return a
non-negative integer. On failure, they return a negative
errno-style error code.</para>
</refsect1>
<function>sd_event_source_get_description()</function> return a non-negative integer. On failure, they
return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -93,18 +91,16 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>source</parameter> is not a valid
pointer to an <structname>sd_event_source</structname>
object or the <parameter>description</parameter> argument for
<function>sd_event_source_get_description()</function> is
<constant>NULL</constant>.</para></listitem>
<listitem><para><parameter>source</parameter> is not a valid pointer to an
<structname>sd_event_source</structname> object or the <parameter>description</parameter> argument
for <function>sd_event_source_get_description()</function> is <constant>NULL</constant>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-ENOMEM</constant></term>
<listitem><para>Not enough memory to copy the
name.</para></listitem>
<listitem><para>Not enough memory to copy the name.</para></listitem>
</varlistentry>
<varlistentry>
@ -117,11 +113,11 @@
<varlistentry>
<term><constant>-ENXIO</constant></term>
<listitem><para>No name was set for the event
source.</para></listitem>
<listitem><para>No name was set for the event source.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

15
man/sd_event_source_set_destroy_callback.xml
View File

@ -69,14 +69,13 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive integer. On
failure, it returns a negative errno-style error code.</para>
<para>On success, <function>sd_event_source_set_destroy_callback()</function> returns 0 or a positive
integer. On failure, it returns a negative errno-style error code.</para>
<para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy callback function
is set, 0 if not. On failure, returns a negative errno-style error code.</para>
</refsect1>
<para><function>sd_event_source_get_destroy_callback()</function> returns positive if the destroy
callback function is set, 0 if not. On failure, returns a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -85,9 +84,11 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>The <parameter>source</parameter> parameter is <constant>NULL</constant>.</para></listitem>
<listitem><para>The <parameter>source</parameter> parameter is <constant>NULL</constant>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

15
man/sd_event_source_set_enabled.xml
View File

@ -100,12 +100,11 @@
<title>Return Value</title>
<para>On success, <function>sd_event_source_set_enabled()</function> returns a non-negative
integer. <function>sd_event_source_get_enabled()</function> returns zero if the source is
disabled (<constant>SD_EVENT_OFF</constant>) and a positive integer otherwise. On failure, they
return a negative errno-style error code.</para>
</refsect1>
integer. <function>sd_event_source_get_enabled()</function> returns zero if the source is disabled
(<constant>SD_EVENT_OFF</constant>) and a positive integer otherwise. On failure, they return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -114,9 +113,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>source</parameter> is not a valid
pointer to an <structname>sd_event_source</structname>
object.</para></listitem>
<listitem><para><parameter>source</parameter> is not a valid pointer to an
<structname>sd_event_source</structname> object.</para></listitem>
</varlistentry>
<varlistentry>
@ -133,6 +131,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

18
man/sd_event_source_set_prepare.xml
View File

@ -73,13 +73,10 @@
<refsect1>
<title>Return Value</title>
<para>On success,
<function>sd_event_source_set_prepare()</function> returns a
non-negative integer. On failure, it returns a negative
errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_event_source_set_prepare()</function> returns a non-negative integer. On
failure, it returns a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -88,9 +85,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>source</parameter> is not a valid
pointer to an <structname>sd_event_source</structname>
object.</para></listitem>
<listitem><para><parameter>source</parameter> is not a valid pointer to an
<structname>sd_event_source</structname> object.</para></listitem>
</varlistentry>
<varlistentry>
@ -115,13 +111,13 @@
<varlistentry>
<term><constant>-EDOM</constant></term>
<listitem><para>The specified event source has been created
with
<listitem><para>The specified event source has been created with
<citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

17
man/sd_event_source_set_priority.xml
View File

@ -106,14 +106,11 @@
<refsect1>
<title>Return Value</title>
<para>On success,
<function>sd_event_source_set_priority()</function> and
<function>sd_event_source_get_priority()</function> return a
non-negative integer. On failure, they return a negative
errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_event_source_set_priority()</function> and
<function>sd_event_source_get_priority()</function> return a non-negative integer. On failure, they
return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -122,9 +119,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para><parameter>source</parameter> is not a valid
pointer to an <structname>sd_event_source</structname>
object.</para></listitem>
<listitem><para><parameter>source</parameter> is not a valid pointer to an
<structname>sd_event_source</structname> object.</para></listitem>
</varlistentry>
<varlistentry>
@ -148,6 +144,7 @@
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

29
man/sd_event_wait.xml
View File

@ -254,20 +254,15 @@
<refsect1>
<title>Return Value</title>
<para>On success, these functions return 0 or a positive integer.
On failure, they return a negative errno-style error code. In case
of <function>sd_event_prepare()</function> and
<function>sd_event_wait()</function>, a positive, non-zero return
code indicates that events are ready to be processed and zero
indicates that no events are ready. In case of
<function>sd_event_dispatch()</function>, a positive, non-zero
return code indicates that the event loop returned to its initial
state and zero indicates the event loop has
exited. <function>sd_event_get_state()</function> returns a
positive or zero state on success.</para>
</refsect1>
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
errno-style error code. In case of <function>sd_event_prepare()</function> and
<function>sd_event_wait()</function>, a positive, non-zero return code indicates that events are ready to
be processed and zero indicates that no events are ready. In case of
<function>sd_event_dispatch()</function>, a positive, non-zero return code indicates that the event loop
returned to its initial state and zero indicates the event loop has
exited. <function>sd_event_get_state()</function> returns a positive or zero state on success.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -276,15 +271,14 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>The <parameter>event</parameter> parameter is
invalid or <constant>NULL</constant>.</para></listitem>
<listitem><para>The <parameter>event</parameter> parameter is invalid or <constant>NULL</constant>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-EBUSY</constant></term>
<listitem><para>The event loop object is not in the right
state.</para></listitem>
<listitem><para>The event loop object is not in the right state.</para></listitem>
</varlistentry>
<varlistentry>
@ -304,6 +298,7 @@
</variablelist>
<para>Other errors are possible, too.</para>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

13
man/sd_get_seats.xml
View File

@ -83,15 +83,11 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_get_seats()</function>,
<function>sd_get_sessions()</function>,
<function>sd_get_uids()</function> and
<function>sd_get_machine_names()</function> return the number of
entries in the arrays. On failure, these calls return a negative
errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_get_seats()</function>, <function>sd_get_sessions()</function>,
<function>sd_get_uids()</function> and <function>sd_get_machine_names()</function> return the number of
entries in the arrays. On failure, these calls return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -104,6 +100,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

9
man/sd_login_monitor_new.xml
View File

@ -206,9 +206,8 @@ else {
<para><function>sd_login_monitor_unref()</function>
always returns <constant>NULL</constant>.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -218,9 +217,8 @@ else {
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted). The specified category to
watch is not known.</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
that is not accepted). The specified category to watch is not known.</para></listitem>
</varlistentry>
<varlistentry>
@ -229,6 +227,7 @@ else {
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

13
man/sd_machine_get_class.xml
View File

@ -66,12 +66,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these calls return 0 or a positive integer. On
failure, these calls return a negative errno-style error
code.</para>
</refsect1>
<para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -88,8 +86,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted).</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
that is not accepted).</para></listitem>
</varlistentry>
<varlistentry>
@ -98,6 +96,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

22
man/sd_pid_get_owner_uid.xml
View File

@ -240,12 +240,10 @@
<refsect1>
<title>Return Value</title>
<para>On success, these calls return 0 or a positive integer. On
failure, these calls return a negative errno-style error
code.</para>
</refsect1>
<para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative
errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -255,31 +253,28 @@
<varlistentry>
<term><constant>-ESRCH</constant></term>
<listitem><para>The specified PID does not refer to a running
process.</para>
<listitem><para>The specified PID does not refer to a running process.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>-EBADF</constant></term>
<listitem><para>The specified socket file descriptor was
invalid.</para></listitem>
<listitem><para>The specified socket file descriptor was invalid.</para></listitem>
</varlistentry>
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>The given field is not specified for the described
process or peer.</para>
<listitem><para>The given field is not specified for the described process or peer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted).</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
that is not accepted).</para></listitem>
</varlistentry>
<varlistentry>
@ -288,6 +283,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>

25
man/sd_seat_get_active.xml
View File

@ -112,18 +112,13 @@
<refsect1>
<title>Return Value</title>
<para> On success, <function>sd_seat_get_active()</function>
returns 0 or a positive integer. On success,
<function>sd_seat_get_sessions()</function> returns the number of
entries in the session identifier array. If the test succeeds,
<function>sd_seat_can_multi_session</function>,
<function>sd_seat_can_tty</function> and
<function>sd_seat_can_graphical</function> return a positive
integer, if it fails 0. On failure, these calls return a negative
errno-style error code.</para>
</refsect1>
<para> On success, <function>sd_seat_get_active()</function> returns 0 or a positive integer. On success,
<function>sd_seat_get_sessions()</function> returns the number of entries in the session identifier
array. If the test succeeds, <function>sd_seat_can_multi_session</function>,
<function>sd_seat_can_tty</function> and <function>sd_seat_can_graphical</function> return a positive
integer, if it fails 0. On failure, these calls return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -133,8 +128,7 @@
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>The given field is not specified for the described
seat.</para>
<listitem><para>The given field is not specified for the described seat.</para>
</listitem>
</varlistentry>
@ -148,8 +142,8 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted).</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
that is not accepted).</para></listitem>
</varlistentry>
<varlistentry>
@ -158,6 +152,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

11
man/sd_session_is_active.xml
View File

@ -262,9 +262,8 @@
<function>sd_session_get_tty()</function> return 0 or
a positive integer. On failure, these calls return a
negative errno-style error code.</para>
</refsect1>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -281,16 +280,15 @@
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>The given field is not specified for the described
session.</para>
<listitem><para>The given field is not specified for the described session.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted).</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where
that is not accepted).</para></listitem>
</varlistentry>
<varlistentry>
@ -299,6 +297,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />

29
man/sd_uid_get_state.xml
View File

@ -131,19 +131,13 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_uid_get_state()</function> returns
0 or a positive integer. If the test succeeds,
<function>sd_uid_is_on_seat()</function> returns a positive
integer; if it fails, 0.
<function>sd_uid_get_sessions()</function> and
<function>sd_uid_get_seats()</function> return the number of
entries in the returned arrays.
<function>sd_uid_get_display()</function> returns a non-negative
code on success. On failure, these calls return a negative
errno-style error code.</para>
</refsect1>
<para>On success, <function>sd_uid_get_state()</function> returns 0 or a positive integer. If the test
succeeds, <function>sd_uid_is_on_seat()</function> returns a positive integer; if it fails, 0.
<function>sd_uid_get_sessions()</function> and <function>sd_uid_get_seats()</function> return the number
of entries in the returned arrays. <function>sd_uid_get_display()</function> returns a non-negative code
on success. On failure, these calls return a negative errno-style error code.</para>
<refsect1>
<refsect2>
<title>Errors</title>
<para>Returned errors may indicate the following problems:</para>
@ -153,8 +147,7 @@
<varlistentry>
<term><constant>-ENODATA</constant></term>
<listitem><para>The given field is not specified for the described
user.</para>
<listitem><para>The given field is not specified for the described user.</para>
</listitem>
</varlistentry>
@ -168,10 +161,9 @@
<varlistentry>
<term><constant>-EINVAL</constant></term>
<listitem><para>An input parameter was invalid (out of range,
or NULL, where that is not accepted). This is also returned if
the passed user ID is 0xFFFF or 0xFFFFFFFF, which are
undefined on Linux.</para></listitem>
<listitem><para>An input parameter was invalid (out of range, or NULL, where that is not
accepted). This is also returned if the passed user ID is <constant>0xFFFF</constant> or
<constant>0xFFFFFFFF</constant>, which are undefined on Linux.</para></listitem>
</varlistentry>
<varlistentry>
@ -180,6 +172,7 @@
<listitem><para>Memory allocation failed.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />