diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-21 14:53:00 +0100 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-21 14:53:00 +0100 |
| commit | b1de39dec8e9acd875e2038e418d7193fb380b41 (patch) | |
| tree | a044b2ad47d393f4f0439462122e5a9ba129b5b1 /man/sd_seat_get_active.xml | |
| parent | 6d99c5d1d9832a2a85c77f8d90767028651f3f35 (diff) | |
| download | systemd-b1de39dec8e9acd875e2038e418d7193fb380b41.tar.gz | |
man: make separate "Errors" sections subsection of "Return value"
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.
Diffstat (limited to 'man/sd_seat_get_active.xml')
| -rw-r--r-- | man/sd_seat_get_active.xml | 65 |
1 files changed, 30 insertions, 35 deletions
diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 6e1cba1163..2dba6803f1 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -112,52 +112,47 @@ <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> - <title>Errors</title> + <refsect2> + <title>Errors</title> - <para>Returned errors may indicate the following problems:</para> + <para>Returned errors may indicate the following problems:</para> - <variablelist> + <variablelist> - <varlistentry> - <term><constant>-ENODATA</constant></term> + <varlistentry> + <term><constant>-ENODATA</constant></term> - <listitem><para>The given field is not specified for the described - seat.</para> - </listitem> - </varlistentry> + <listitem><para>The given field is not specified for the described seat.</para> + </listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENXIO</constant></term> + <varlistentry> + <term><constant>-ENXIO</constant></term> - <listitem><para>The specified seat is unknown.</para> - </listitem> - </varlistentry> + <listitem><para>The specified seat is unknown.</para> + </listitem> + </varlistentry> - <varlistentry> - <term><constant>-EINVAL</constant></term> + <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> - </varlistentry> + <listitem><para>An input parameter was invalid (out of range, or <constant>NULL</constant>, where + that is not accepted).</para></listitem> + </varlistentry> - <varlistentry> - <term><constant>-ENOMEM</constant></term> + <varlistentry> + <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para></listitem> - </varlistentry> - </variablelist> + <listitem><para>Memory allocation failed.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |