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_bus_creds_get_pid.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_bus_creds_get_pid.xml')
-rw-r--r-- | man/sd_bus_creds_get_pid.xml | 101 |
1 files changed, 46 insertions, 55 deletions
diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml index 97ff01226b..9e79d13cdd 100644 --- a/man/sd_bus_creds_get_pid.xml +++ b/man/sd_bus_creds_get_pid.xml @@ -455,62 +455,53 @@ <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> - <title>Errors</title> - - <para>Returned errors may indicate the following problems:</para> - - <variablelist> - <varlistentry> - <term><constant>-ENODATA</constant></term> - - <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>, - <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_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> - </varlistentry> - - <varlistentry> - <term><constant>-EINVAL</constant></term> - - <listitem><para>Specified pointer parameter is <constant>NULL</constant>. - </para></listitem> - </varlistentry> - - <varlistentry> - <term><constant>-ENOMEM</constant></term> - - <listitem><para>Memory allocation failed.</para></listitem> - </varlistentry> - </variablelist> + <refsect2> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + <varlistentry> + <term><constant>-ENODATA</constant></term> + + <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>, + <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_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> + </varlistentry> + + <varlistentry> + <term><constant>-EINVAL</constant></term> + + <listitem><para>Specified pointer parameter is <constant>NULL</constant>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ENOMEM</constant></term> + + <listitem><para>Memory allocation failed.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |