summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mack <daniel@zonque.org>2015-01-28 17:37:10 +0100
committerDaniel Mack <daniel@zonque.org>2015-01-28 17:37:10 +0100
commitb1879b7899cd7e1e27179ce014aec058cf5154d2 (patch)
treeb26b16557fa0c9615c5ca0df732c0ee731f1fa18
parent4adbd45592e782cd7342012aff704eee618d1e67 (diff)
downloadkdbus-bus-b1879b7899cd7e1e27179ce014aec058cf5154d2.tar.gz
kdbus-bus-b1879b7899cd7e1e27179ce014aec058cf5154d2.tar.bz2
kdbus-bus-b1879b7899cd7e1e27179ce014aec058cf5154d2.zip
doc: more return value section cleanups
Signed-off-by: Daniel Mack <daniel@zonque.org>
-rw-r--r--doc/kdbus.bus.xml5
-rw-r--r--doc/kdbus.connection.xml5
-rw-r--r--doc/kdbus.endpoint.xml5
-rw-r--r--doc/kdbus.match.xml5
-rw-r--r--doc/kdbus.message.xml5
-rw-r--r--doc/kdbus.names.xml5
-rw-r--r--doc/kdbus.pool.xml11
7 files changed, 23 insertions, 18 deletions
diff --git a/doc/kdbus.bus.xml b/doc/kdbus.bus.xml
index 52ae9f2cd57..b2248e805fc 100644
--- a/doc/kdbus.bus.xml
+++ b/doc/kdbus.bus.xml
@@ -210,8 +210,9 @@ struct kdbus_cmd_make {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.connection.xml b/doc/kdbus.connection.xml
index 41d20eccbb6..10f5ed908da 100644
--- a/doc/kdbus.connection.xml
+++ b/doc/kdbus.connection.xml
@@ -816,8 +816,9 @@ struct kdbus_cmd_update {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.endpoint.xml b/doc/kdbus.endpoint.xml
index 78caf381eaa..b2bf61d1961 100644
--- a/doc/kdbus.endpoint.xml
+++ b/doc/kdbus.endpoint.xml
@@ -256,8 +256,9 @@ struct kdbus_cmd_make {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.match.xml b/doc/kdbus.match.xml
index cc4c1608fb4..90273a475e7 100644
--- a/doc/kdbus.match.xml
+++ b/doc/kdbus.match.xml
@@ -397,8 +397,9 @@ struct kdbus_cmd_match {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.message.xml b/doc/kdbus.message.xml
index 61b335560ea..c4a983f2b24 100644
--- a/doc/kdbus.message.xml
+++ b/doc/kdbus.message.xml
@@ -763,8 +763,9 @@ struct kdbus_msg_info {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.names.xml b/doc/kdbus.names.xml
index 816b337424d..aa8e3466c1f 100644
--- a/doc/kdbus.names.xml
+++ b/doc/kdbus.names.xml
@@ -476,8 +476,9 @@ struct kdbus_name_info {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>
diff --git a/doc/kdbus.pool.xml b/doc/kdbus.pool.xml
index db9d3c3a9b2..173c60d2463 100644
--- a/doc/kdbus.pool.xml
+++ b/doc/kdbus.pool.xml
@@ -110,10 +110,8 @@ buf = mmap(NULL, POOL_SIZE, PROT_READ, MAP_SHARED, conn_fd, 0);
<para>
When access to the pool memory is no longer needed, userspace should
- call
- <citerefentry><refentrytitle>munmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>
- on the pointer returned by
- <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>.
+ call <function>munmap</function> on the pointer returned by
+ <function>mmap</function>.
</para>
</refsect1>
@@ -198,8 +196,9 @@ struct kdbus_cmd_free {
<refsect1>
<title>Return value</title>
<para>
- On success, all metioned ioctl commands return 0; on error, -1 is
- returned, and errno is set to indicate the error.
+ On success, all metioned ioctl commands return <errorcode>0</errorcode>;
+ on error, <errorcode>-1</errorcode> is returned, and
+ <varname>errno</varname> is set to indicate the error.
</para>
<refsect2>