Add route table guide and formatting tweaks

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

diff --git a/docs/rmr_bytes2payload.3.rst b/docs/rmr_bytes2payload.3.rst
index f489bc0..f9dc183 100644 (file)
--- a/docs/rmr_bytes2payload.3.rst
+++ b/docs/rmr_bytes2payload.3.rst
@@ -1,61 +1,67 @@
- 
- 
 .. 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_bytes2payload 
 ============================================================================================ 
  
-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 
  
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
 rmr_bytes2payload 
- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SYNOPSIS
+--------
+
  
 :: 
-  
+ 
  #include <rmr/rmr.h>
+  
  void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  
- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
+
+
+DESCRIPTION
+-----------
+
 This is a convenience function as some wrapper languages 
 might not have the ability to directly copy into the payload 
 buffer. The bytes from *src* for the length given are copied 
 to the payload. It is the caller's responsibility to ensure 
 that the payload is large enough. Upon successfully copy, the 
-len field in the message buffer is updated to reflect the 
+``len`` field in the message buffer is updated to reflect the 
 number of bytes copied. 
  
 There is little error checking, and no error reporting. 
- 
-RETURN VALUE 
--------------------------------------------------------------------------------------------- 
- 
+
+
+RETURN VALUE
+------------
+
 None. 
- 
-EXAMPLE 
--------------------------------------------------------------------------------------------- 
- 
- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
+
+
+EXAMPLE
+-------
+
+
+
+SEE ALSO
+--------
+
 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2payload(3), 
 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), 
 rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3),