Add route table guide and formatting tweaks

[ric-plt/lib/rmr.git] / docs / rmr_set_trace.3.rst

diff --git a/docs/rmr_set_trace.3.rst b/docs/rmr_set_trace.3.rst
index 08c4b69..89c114e 100644 (file)
--- a/docs/rmr_set_trace.3.rst
+++ b/docs/rmr_set_trace.3.rst
@@ -1,55 +1,61 @@
- 
- 
 .. 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_set_trace 
 ============================================================================================ 
  
-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 
  
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
 rmr_set_trace 
- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SYNOPSIS
+--------
+
  
 :: 
-  
+ 
  #include <rmr/rmr.h>
+  
  int rmr_set_trace( rmr_mbuf_t* mbuf, unsigned char* data, int len )
  
- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
-The rmr_set_trace function will copy len bytes from data into 
-the trace portion of mbuf. If the trace area of mbuf is not 
-the correct size, the message buffer will be reallocated to 
-ensure that enough space is available for the trace data. 
- 
-RETURN VALUE 
--------------------------------------------------------------------------------------------- 
- 
-The rmr_set_trace function returns the number of bytes 
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_set_trace`` function will copy ``len`` bytes from 
+``data`` into the trace portion of ``mbuf.`` If the trace 
+area of ``mbuf`` is not the correct size, the message buffer 
+will be reallocated to ensure that enough space is available 
+for the trace data. 
+
+
+RETURN VALUE
+------------
+
+The ``rmr_set_trace`` function returns the number of bytes 
 successfully copied to the message. If 0 is returned either 
 the message pointer was nil, or the size in the parameters 
 was <= 0. 
- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SEE ALSO
+--------
+
 rmr_alloc_msg(3), rmr_tralloc_msg(3), rmr_bytes2xact(3), 
 rmr_bytes2payload(3), rmr_call(3), rmr_free_msg(3), 
 rmr_get_rcvfd(3), rmr_get_meid(3), rmr_get_trace(3),