X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_str2xact.3.rst;h=968f0c65874a3da29cbf5ead844efa63525eabdd;hb=a3a121ca4a0426ec964fa684fb27c397f2ee9e24;hp=d34e6b7aa0fdbe7d11a5f70d2fc51f178c60913d;hpb=503fe41e88b66ff8986c991bfbd075331b0bd166;p=ric-plt%2Flib%2Frmr.git

diff --git a/docs/rmr_str2xact.3.rst b/docs/rmr_str2xact.3.rst
index d34e6b7..968f0c6 100644
--- a/docs/rmr_str2xact.3.rst
+++ b/docs/rmr_str2xact.3.rst
@@ -1,80 +1,91 @@
- 
- 
 .. This work is licensed under a Creative Commons Attribution 4.0 International License. 
 .. SPDX-License-Identifier: CC-BY-4.0 
 .. CAUTION: this document is generated from source in doc/src/rtd. 
 .. To make changes edit the source and recompile the document. 
 .. Do NOT make changes directly to .rst or .md files. 
  
- 
 ============================================================================================ 
 Man Page: rmr_str2xact 
 ============================================================================================ 
  
-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 
  
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
 rmr_str2xact 
- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SYNOPSIS
+--------
+
  
 :: 
-  
+ 
  #include <rmr/rmr.h>
+  
  int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  
- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
-The rmr_str2xact function will copy the string pointed to by 
-src to the transaction ID (xaction) field in the given 
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_str2xact`` function will copy the string pointed to 
+by src to the transaction ID (xaction) field in the given 
 message. The field is a fixed length, gated by the constant 
-RMR_MAX_XID and if string length is larger than this value, 
-then **nothing** will be copied. (Note, this differs slightly 
-from the behaviour of the lrmr_bytes2xact() function.) 
- 
- 
-RETURN VALUE 
--------------------------------------------------------------------------------------------- 
- 
+``RMR_MAX_XID`` and if string length is larger than this 
+value, then **nothing** will be copied. (Note, this differs 
+slightly from the behaviour of the ``lrmr_bytes2xact()`` 
+function.) 
+
+
+RETURN VALUE
+------------
+
 On success, the value RMR_OK is returned. If the string 
-cannot be copied to the message, the return value will be 
-one of the errors listed below. 
- 
-ERRORS 
--------------------------------------------------------------------------------------------- 
- 
-If the return value is not RMR_OK, then it will be set to 
-one of the values below. 
- 
- 
-RMR_ERR_BADARG 
-   
-  The message, or an internal portion of the message, was 
-  corrupted or the pointer was invalid. 
-   
- 
-RMR_ERR_OVERFLOW 
-   
-  The length passed in was larger than the maximum length of 
-  the field; only a portion of the source bytes were copied. 
- 
- 
-EXAMPLE 
--------------------------------------------------------------------------------------------- 
- 
- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
+cannot be copied to the message, the return value will be one 
+of the errors listed below. 
+
+
+ERRORS
+------
+
+If the return value is not RMR_OK, then it will be set to one 
+of the values below. 
+ 
+   .. list-table:: 
+     :widths: auto 
+     :header-rows: 0 
+     :class: borderless 
+      
+     * - **RMR_ERR_BADARG** 
+       - 
+         The message, or an internal portion of the message, was 
+         corrupted or the pointer was invalid. 
+      
+     * - **RMR_ERR_OVERFLOW** 
+       - 
+         The length passed in was larger than the maximum length of 
+         the field; only a portion of the source bytes were copied. 
+          
+ 
+
+
+EXAMPLE
+-------
+
+
+
+SEE ALSO
+--------
+
 rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_bytes2xact(3), 
 rmr_call(3), rmr_free_msg(3), rmr_get_meid(3), 
 rmr_get_rcvfd(3), rmr_get_xact(3), rmr_payload_size(3),