Add route table guide and formatting tweaks

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

diff --git a/docs/rmr_free_msg.3.rst b/docs/rmr_free_msg.3.rst
index dbcdb98..b35905c 100644 (file)
--- a/docs/rmr_free_msg.3.rst
+++ b/docs/rmr_free_msg.3.rst
@@ -1,53 +1,57 @@
- 
- 

 .. 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. 
  
 .. 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_free_msg 
 ============================================================================================ 
  
 ============================================================================================ 
 Man Page: rmr_free_msg 
 ============================================================================================ 
  

-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 

  
  

+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+

 rmr_free_msg 
 rmr_free_msg 

- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SYNOPSIS
+--------
+

  
 :: 
  
 :: 

-  
+ 

  #include <rmr/rmr.h>
  #include <rmr/rmr.h>

+  

  void rmr_free_msg( rmr_mbuf_t* mbuf );
  
  void rmr_free_msg( rmr_mbuf_t* mbuf );
  

- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
+
+
+DESCRIPTION
+-----------
+

 The message buffer is returned to the pool, or the associated 
 memory is released depending on the needs of the underlying 
 messaging system. This allows the user application to release 
 a buffer that is not going to be used. It is safe to pass a 
 nil pointer to this function, and doing so does not result in 
 The message buffer is returned to the pool, or the associated 
 memory is released depending on the needs of the underlying 
 messaging system. This allows the user application to release 
 a buffer that is not going to be used. It is safe to pass a 
 nil pointer to this function, and doing so does not result in 

-a change to the value of errrno. 
+a change to the value of ``errrno.`` 

  
 After calling, the user application should **not** use any of 
 the pointers (transaction ID, or payload) which were 
 available. 
  
 After calling, the user application should **not** use any of 
 the pointers (transaction ID, or payload) which were 
 available. 

- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SEE ALSO
+--------
+

 rmr_alloc_msg(3), rmr_call(3), rmr_init(3), 
 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), 
 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3), 
 rmr_alloc_msg(3), rmr_call(3), rmr_init(3), 
 rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), 
 rmr_rcv_specific(3), rmr_rts_msg(3), rmr_ready(3),