summaryrefslogtreecommitdiff
path: root/man/sd_id128_get_machine.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:08:34 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-03-21 14:13:02 +0100
commit6d99c5d1d9832a2a85c77f8d90767028651f3f35 (patch)
treed22c9f6f8e52b37e9f341cd3c85f32e8b262e88b /man/sd_id128_get_machine.xml
parentc924888ffd4183083a5c2b37bc8b30aed7263f68 (diff)
downloadsystemd-6d99c5d1d9832a2a85c77f8d90767028651f3f35.tar.gz
man: document error values for sd_id128_get_*()
Diffstat (limited to 'man/sd_id128_get_machine.xml')
-rw-r--r--man/sd_id128_get_machine.xml53
1 files changed, 47 insertions, 6 deletions
diff --git a/man/sd_id128_get_machine.xml b/man/sd_id128_get_machine.xml
index 59620ab77b..e665f7343f 100644
--- a/man/sd_id128_get_machine.xml
+++ b/man/sd_id128_get_machine.xml
@@ -115,12 +115,53 @@
<title>Return Value</title>
<para>Those calls return 0 on success (in which case <parameter>ret</parameter> is filled in),
- or a negative errno-style error code. In particular,
- <function>sd_id128_get_machine()</function>,
- <function>sd_id128_get_machine_app_specific()</function>, and
- <function>sd_id128_get_boot_app_specific()</function> return <constant>-ENOENT</constant> if
- <filename>/etc/machine-id</filename> is missing, and <constant>-ENOMEDIUM</constant> if
- <filename>/etc/machine-id</filename> is empty or all zeros.</para>
+ or a negative errno-style error code.</para>
+
+ <refsect2>
+ <title>Errors</title>
+ <para>Returned errors may indicate the following problems:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><constant>-ENOENT</constant></term>
+
+ <listitem><para>Returned by <function>sd_id128_get_machine()</function>,
+ <function>sd_id128_get_machine_app_specific()</function>, and
+ <function>sd_id128_get_boot_app_specific()</function> when <filename>/etc/machine-id</filename> is
+ missing.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><constant>-ENOMEDIUM</constant></term>
+
+ <listitem><para>Returned by <function>sd_id128_get_machine()</function>,
+ <function>sd_id128_get_machine_app_specific()</function>, and
+ <function>sd_id128_get_boot_app_specific()</function> when <filename>/etc/machine-id</filename> is
+ empty or all zeros.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><constant>-ENXIO</constant></term>
+
+ <listitem><para>Returned by <function>sd_id128_get_invocation()</function> if no invocation ID is
+ set.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><constant>-EIO</constant></term>
+
+ <listitem><para>Returned by any of the functions described here when the configured value has
+ invalid format.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><constant>-EPERM</constant></term>
+
+ <listitem><para>Requested information could not be retrieved because of insufficient permissions.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />