diff options
author | Daniel Mack <daniel@zonque.org> | 2015-01-28 11:59:12 +0100 |
---|---|---|
committer | Daniel Mack <daniel@zonque.org> | 2015-01-28 11:59:12 +0100 |
commit | 6237dc71448b8b8f0f1fbeaafc5a16867f60c8db (patch) | |
tree | f23b931b984c2d7651f598d4d729446032b3fa35 | |
parent | da36403b8bf12b11fbaa8bb6f0b732448ec05c73 (diff) | |
download | kdbus-bus-6237dc71448b8b8f0f1fbeaafc5a16867f60c8db.tar.gz kdbus-bus-6237dc71448b8b8f0f1fbeaafc5a16867f60c8db.tar.bz2 kdbus-bus-6237dc71448b8b8f0f1fbeaafc5a16867f60c8db.zip |
doc: error code section cleanups
Signed-off-by: Daniel Mack <daniel@zonque.org>
-rw-r--r-- | doc/kdbus.bus.xml | 15 | ||||
-rw-r--r-- | doc/kdbus.connection.xml | 47 | ||||
-rw-r--r-- | doc/kdbus.endpoint.xml | 21 | ||||
-rw-r--r-- | doc/kdbus.match.xml | 17 | ||||
-rw-r--r-- | doc/kdbus.message.xml | 69 | ||||
-rw-r--r-- | doc/kdbus.names.xml | 29 | ||||
-rw-r--r-- | doc/kdbus.pool.xml | 11 |
7 files changed, 108 insertions, 101 deletions
diff --git a/doc/kdbus.bus.xml b/doc/kdbus.bus.xml index 92571f62f4e..5698331d1dc 100644 --- a/doc/kdbus.bus.xml +++ b/doc/kdbus.bus.xml @@ -206,22 +206,23 @@ struct kdbus_cmd_make { <refsect1> <title>Return value</title> <para> - On success, all mentioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_BUS_MAKE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_BUS_MAKE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EBADMSG</varname></term> + <term><varname>EBADMSG</varname></term> <listitem><para> A mandatory item is missing. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The flags supplied in the <varname>struct kdbus_cmd_make</varname> are invalid or the supplied name does not start with the current @@ -230,21 +231,21 @@ struct kdbus_cmd_make { </varlistentry> <varlistentry> - <term><varname>-EEXIST</varname></term> + <term><varname>EEXIST</varname></term> <listitem><para> A bus of that name already exists. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ESHUTDOWN</varname></term> + <term><varname>ESHUTDOWN</varname></term> <listitem><para> The kdbus mount instance for the bus was already shut down. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EMFILE</varname></term> + <term><varname>EMFILE</varname></term> <listitem><para> The maximum number of buses for the current user is exhausted. </para></listitem> diff --git a/doc/kdbus.connection.xml b/doc/kdbus.connection.xml index 4160c4deb09..7ba41633fdc 100644 --- a/doc/kdbus.connection.xml +++ b/doc/kdbus.connection.xml @@ -811,22 +811,23 @@ struct kdbus_cmd_update { <refsect1> <title>Return value</title> <para> - On success, all metioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_HELLO</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_HELLO</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EFAULT</varname></term> + <term><varname>EFAULT</varname></term> <listitem><para> The supplied pool size was 0 or not a multiple of the page size. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The flags supplied in <varname>struct kdbus_cmd_make</varname> are invalid. @@ -834,7 +835,7 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> An illegal combination of <varname>KDBUS_HELLO_MONITOR</varname>, @@ -844,14 +845,14 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> An invalid set of items was supplied. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ECONNREFUSED</varname></term> + <term><varname>ECONNREFUSED</varname></term> <listitem><para> The attach_flags_send field did not satisfy the requirements of the bus. @@ -859,7 +860,7 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-EPERM</varname></term> + <term><varname>EPERM</varname></term> <listitem><para> A <varname>KDBUS_ITEM_CREDS</varname> items was supplied, but the current user is not privileged. @@ -867,21 +868,21 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-ESHUTDOWN</varname></term> + <term><varname>ESHUTDOWN</varname></term> <listitem><para> The bus you were trying to connect to has already been shut down. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EMFILE</varname></term> + <term><varname>EMFILE</varname></term> <listitem><para> The maximum number of connections on the bus has been reached. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EOPNOTSUPP</varname></term> + <term><varname>EOPNOTSUPP</varname></term> <listitem><para> The endpoint does not support the connection flags supplied in <varname>struct kdbus_cmd_hello</varname>. @@ -891,18 +892,18 @@ struct kdbus_cmd_update { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_BYEBYE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_BYEBYE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EALREADY</varname></term> + <term><varname>EALREADY</varname></term> <listitem><para> The connection has already been shut down. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EBUSY</varname></term> + <term><varname>EBUSY</varname></term> <listitem><para> There are still messages queued up in the connection's pool. </para></listitem> @@ -911,11 +912,11 @@ struct kdbus_cmd_update { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_CONN_INFO</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_CONN_INFO</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Invalid flags, or neither an ID nor a name was provided, or the name is invalid. @@ -923,14 +924,14 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-ESRCH</varname></term> + <term><varname>ESRCH</varname></term> <listitem><para> Connection lookup by name failed. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ENXIO</varname></term> + <term><varname>ENXIO</varname></term> <listitem><para> No connection with the provided connection ID found. </para></listitem> @@ -939,18 +940,18 @@ struct kdbus_cmd_update { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_CONN_UPDATE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_CONN_UPDATE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal flags or items. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Wildcards submitted in policy entries, or illegal sequence of policy items. @@ -958,14 +959,14 @@ struct kdbus_cmd_update { </varlistentry> <varlistentry> - <term><varname>-EOPNOTSUPP</varname></term> + <term><varname>EOPNOTSUPP</varname></term> <listitem><para> Operation not supported by connection. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-E2BIG</varname></term> + <term><varname>E2BIG</varname></term> <listitem><para> Too many policy items attached. </para></listitem> diff --git a/doc/kdbus.endpoint.xml b/doc/kdbus.endpoint.xml index 8ab7540a1f5..2afa016cfc7 100644 --- a/doc/kdbus.endpoint.xml +++ b/doc/kdbus.endpoint.xml @@ -256,15 +256,16 @@ struct kdbus_cmd_make { <refsect1> <title>Return value</title> <para> - On success, all mentioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_ENDPOINT_MAKE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_ENDPOINT_MAKE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The flags supplied in the <varname>struct kdbus_cmd_make</varname> are invalid. @@ -272,7 +273,7 @@ struct kdbus_cmd_make { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal combination of <varname>KDBUS_ITEM_NAME</varname> and <varname>KDBUS_ITEM_POLICY_ACCESS</varname> was provided. @@ -280,14 +281,14 @@ struct kdbus_cmd_make { </varlistentry> <varlistentry> - <term><varname>-EEXIST</varname></term> + <term><varname>EEXIST</varname></term> <listitem><para> An endpoint of that name already exists. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EPERM</varname></term> + <term><varname>EPERM</varname></term> <listitem><para> The calling user is not privileged. See <citerefentry><refentrytitle>kdbus</refentrytitle><manvolnum>7</manvolnum></citerefentry> @@ -298,11 +299,11 @@ struct kdbus_cmd_make { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_ENDPOINT_UPDATE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_ENDPOINT_UPDATE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The flags supplied in the <varname>struct kdbus_cmd_update</varname> are invalid. @@ -310,7 +311,7 @@ struct kdbus_cmd_make { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal combination of <varname>KDBUS_ITEM_NAME</varname> and <varname>KDBUS_ITEM_POLICY_ACCESS</varname> was provided. @@ -318,7 +319,7 @@ struct kdbus_cmd_make { </varlistentry> <varlistentry> - <term><varname>-EEXIST</varname></term> + <term><varname>EEXIST</varname></term> <listitem><para> An endpoint of that name already exists. </para></listitem> diff --git a/doc/kdbus.match.xml b/doc/kdbus.match.xml index e260fdd6a2a..ff8d15ebb22 100644 --- a/doc/kdbus.match.xml +++ b/doc/kdbus.match.xml @@ -397,29 +397,30 @@ struct kdbus_cmd_match { <refsect1> <title>Return value</title> <para> - On success, all mentioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_MATCH_ADD</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_MATCH_ADD</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal flags or items. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EDOM</varname></term> + <term><varname>EDOM</varname></term> <listitem><para> Illegal bloom filter size. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EMFILE</varname></term> + <term><varname>EMFILE</varname></term> <listitem><para> Too many matches for this connection. </para></listitem> @@ -428,18 +429,18 @@ struct kdbus_cmd_match { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_MATCH_REMOVE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_MATCH_REMOVE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal flags. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EBADSLT</varname></term> + <term><varname>EBADSLT</varname></term> <listitem><para> A match entry with the given cookie could not be found. </para></listitem> diff --git a/doc/kdbus.message.xml b/doc/kdbus.message.xml index 3482961a5da..167cd59dc7f 100644 --- a/doc/kdbus.message.xml +++ b/doc/kdbus.message.xml @@ -753,15 +753,16 @@ struct kdbus_msg_info { <refsect1> <title>Return value</title> <para> - On success, all metioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_SEND</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_SEND</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EOPNOTSUPP</varname></term> + <term><varname>EOPNOTSUPP</varname></term> <listitem><para> The connection is not an ordinary connection, or the passed file descriptors are either kdbus handles or unix domain @@ -770,7 +771,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The submitted payload type is <varname>KDBUS_PAYLOAD_KERNEL</varname>, <varname>KDBUS_MSG_EXPECT_REPLY</varname> was set without timeout or @@ -783,7 +784,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ENOTUNIQ</varname></term> + <term><varname>ENOTUNIQ</varname></term> <listitem><para> The supplied destination is <varname>KDBUS_DST_ID_BROADCAST</varname>, a file descriptor was passed, <varname>KDBUS_MSG_EXPECT_REPLY</varname> @@ -792,14 +793,14 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-E2BIG</varname></term> + <term><varname>E2BIG</varname></term> <listitem><para> Too many items </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EMSGSIZE</varname></term> + <term><varname>EMSGSIZE</varname></term> <listitem><para> The size of the message header and items or the payload vector is excessive. @@ -807,7 +808,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EEXIST</varname></term> + <term><varname>EEXIST</varname></term> <listitem><para> Multiple <varname>KDBUS_ITEM_FDS</varname>, <varname>KDBUS_ITEM_BLOOM_FILTER</varname> or @@ -816,7 +817,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EBADF</varname></term> + <term><varname>EBADF</varname></term> <listitem><para> The supplied <varname>KDBUS_ITEM_FDS</varname> or <varname>KDBUS_ITEM_PAYLOAD_MEMFD</varname> items @@ -825,21 +826,21 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EMEDIUMTYPE</varname></term> + <term><varname>EMEDIUMTYPE</varname></term> <listitem><para> The supplied memfd is not a sealed kdbus memfd. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EMFILE</varname></term> + <term><varname>EMFILE</varname></term> <listitem><para> Too many file descriptors inside a <varname>KDBUS_ITEM_FDS</varname>. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EBADMSG</varname></term> + <term><varname>EBADMSG</varname></term> <listitem><para> An item had illegal size, both a <varname>dst_id</varname> and a <varname>KDBUS_ITEM_DST_NAME</varname> was given, or both a name @@ -848,7 +849,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ETXTBSY</varname></term> + <term><varname>ETXTBSY</varname></term> <listitem><para> The supplied kdbus memfd file cannot be sealed or the seal was removed, because it is shared with other processes or @@ -858,14 +859,14 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ECOMM</varname></term> + <term><varname>ECOMM</varname></term> <listitem><para> A peer does not accept the file descriptors addressed to it. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EFAULT</varname></term> + <term><varname>EFAULT</varname></term> <listitem><para> The supplied bloom filter size was not 64-bit aligned or memory supplied by userspace could not be accessed by the kernel. @@ -873,7 +874,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EDOM</varname></term> + <term><varname>EDOM</varname></term> <listitem><para> The supplied bloom filter size did not match the bloom filter size of the bus. @@ -881,7 +882,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EDESTADDRREQ</varname></term> + <term><varname>EDESTADDRREQ</varname></term> <listitem><para> <varname>dst_id</varname> was set to <varname>KDBUS_DST_ID_NAME</varname>, but no @@ -890,14 +891,14 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ESRCH</varname></term> + <term><varname>ESRCH</varname></term> <listitem><para> The name to look up was not found in the name registry. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EADDRNOTAVAIL</varname></term> + <term><varname>EADDRNOTAVAIL</varname></term> <listitem><para> <varname>KDBUS_MSG_NO_AUTO_START</varname> was given but the destination connection is an activator. @@ -905,7 +906,7 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ENXIO</varname></term> + <term><varname>ENXIO</varname></term> <listitem><para> The passed numeric destination connection ID couldn't be found, or is not connected. @@ -913,28 +914,28 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ECONNRESET</varname></term> + <term><varname>ECONNRESET</varname></term> <listitem><para> The destination connection is no longer active. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ETIMEDOUT</varname></term> + <term><varname>ETIMEDOUT</varname></term> <listitem><para> Timeout while synchronously waiting for a reply. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINTR</varname></term> + <term><varname>EINTR</varname></term> <listitem><para> Interrupted system call while synchronously waiting for a reply. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EPIPE</varname></term> + <term><varname>EPIPE</varname></term> <listitem><para> When sending a message, a synchronous reply from the receiving connection was expected but the connection died before answering. @@ -942,14 +943,14 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-ENOBUFS</varname></term> + <term><varname>ENOBUFS</varname></term> <listitem><para> Too many pending messages on the receiver side. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EREMCHG</varname></term> + <term><varname>EREMCHG</varname></term> <listitem><para> Both a well-known name and a unique name (ID) was given, but the name is not currently owned by that connection. @@ -957,14 +958,14 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EXFULL</varname></term> + <term><varname>EXFULL</varname></term> <listitem><para> The memory pool of the receiver is full. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EREMOTEIO</varname></term> + <term><varname>EREMOTEIO</varname></term> <listitem><para> While synchronously waiting for a reply, the remote peer failed with an I/O error. @@ -974,11 +975,11 @@ struct kdbus_msg_info { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_RECV</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_RECV</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EOPNOTSUPP</varname></term> + <term><varname>EOPNOTSUPP</varname></term> <listitem><para> The connection is not an ordinary connection, or the passed file descriptors are either kdbus handles or unix domain @@ -987,28 +988,28 @@ struct kdbus_msg_info { </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Invalid flags or offset. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EAGAIN</varname></term> + <term><varname>EAGAIN</varname></term> <listitem><para> No message found in the queue </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ENOMSG</varname></term> + <term><varname>ENOMSG</varname></term> <listitem><para> No message of the requested priority found. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EOVERFLOW</varname></term> + <term><varname>EOVERFLOW</varname></term> <listitem><para> Some messages have been lost. </para></listitem> diff --git a/doc/kdbus.names.xml b/doc/kdbus.names.xml index 09f0c7a683c..64e32fe0e49 100644 --- a/doc/kdbus.names.xml +++ b/doc/kdbus.names.xml @@ -476,15 +476,16 @@ struct kdbus_name_info { <refsect1> <title>Return value</title> <para> - On success, all metioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_NAME_ACQUIRE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_NAME_ACQUIRE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Illegal command flags, illegal name provided, or an activator tried to acquire a second name. @@ -492,28 +493,28 @@ struct kdbus_name_info { </varlistentry> <varlistentry> - <term><varname>-EPERM</varname></term> + <term><varname>EPERM</varname></term> <listitem><para> Policy prohibited name ownership. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EALREADY</varname></term> + <term><varname>EALREADY</varname></term> <listitem><para> Connection already owns that name. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EEXIST</varname></term> + <term><varname>EEXIST</varname></term> <listitem><para> The name already exists and can not be taken over. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-E2BIG</varname></term> + <term><varname>E2BIG</varname></term> <listitem><para> The maximum number of well-known names per connection is exhausted. </para></listitem> @@ -522,25 +523,25 @@ struct kdbus_name_info { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_NAME_RELEASE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_NAME_RELEASE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Invalid command flags, or invalid name provided. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ESRCH</varname></term> + <term><varname>ESRCH</varname></term> <listitem><para> Name is not found in the registry. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EADDRINUSE</varname></term> + <term><varname>EADDRINUSE</varname></term> <listitem><para> Name is owned by a different connection and can't be released. </para></listitem> @@ -549,18 +550,18 @@ struct kdbus_name_info { </refsect2> <refsect2> - <title><varname>KDBUS_CMD_NAME_LIST</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_NAME_LIST</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Invalid command flags </para></listitem> </varlistentry> <varlistentry> - <term><varname>-ENOBUFS</varname></term> + <term><varname>ENOBUFS</varname></term> <listitem><para> No available memory in the connection's pool. </para></listitem> diff --git a/doc/kdbus.pool.xml b/doc/kdbus.pool.xml index 5d34dffaa36..d5364f97e14 100644 --- a/doc/kdbus.pool.xml +++ b/doc/kdbus.pool.xml @@ -197,29 +197,30 @@ struct kdbus_cmd_free { <refsect1> <title>Return value</title> <para> - On success, all metioned ioctl commands return 0. + On success, all metioned ioctl commands return 0; on error, -1 is + returned, and errno is set to indicate the error. </para> <refsect2> - <title><varname>KDBUS_CMD_FREE</varname> may return the following errors</title> + <title><varname>KDBUS_CMD_FREE</varname> may fail with the following errors</title> <variablelist> <varlistentry> - <term><varname>-ENXIO</varname></term> + <term><varname>ENXIO</varname></term> <listitem><para> No pool slice found at given offset. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> Invalid flags provided. </para></listitem> </varlistentry> <varlistentry> - <term><varname>-EINVAL</varname></term> + <term><varname>EINVAL</varname></term> <listitem><para> The offset is valid, but the user is not allowed to free the slice. This happens, for example, if the offset was retrieved with |