doc: more return value section cleanups
authorDaniel Mack <daniel@zonque.org>
Wed, 28 Jan 2015 16:37:10 +0000 (17:37 +0100)
committerDaniel Mack <daniel@zonque.org>
Wed, 28 Jan 2015 16:37:10 +0000 (17:37 +0100)
Signed-off-by: Daniel Mack <daniel@zonque.org>
doc/kdbus.bus.xml
doc/kdbus.connection.xml
doc/kdbus.endpoint.xml
doc/kdbus.match.xml
doc/kdbus.message.xml
doc/kdbus.names.xml
doc/kdbus.pool.xml

index 52ae9f2cd572fd14f33cc33e58f9722bf7be1367..b2248e805fce1d9a04eef2c31d1755809d881eb2 100644 (file)
@@ -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>
index 41d20eccbb679c8ca7ba32f4e7be117c2c29b143..10f5ed908da516b862e5f70ae4533acc4659920a 100644 (file)
@@ -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>
index 78caf381eaa521400cdf3dc7e0e57f4d20203c32..b2bf61d19612c9cd112d253d509f9705cd415d6b 100644 (file)
@@ -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>
index cc4c1608fb45851e270db8d125575a69f96a3f84..90273a475e721cd2730eb29c7db1ee47fa1197d7 100644 (file)
@@ -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>
index 61b335560ea402c289e9af477f01fe7e9ec794db..c4a983f2b24d05333203d6bf5567f6fe8d75360c 100644 (file)
@@ -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>
index 816b337424df77ad9947ff366597b6988ccb2bf6..aa8e3466c1f39b924715082a762e53565bc3a5e3 100644 (file)
@@ -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>
index db9d3c3a9b2ebfa20ad336f3f82cbbda63993f83..173c60d2463b2897939c9c99c01d354457c1f768 100644 (file)
@@ -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>