From: E. Scott Daniels <daniels@research.att.com>
Date: Mon, 8 Jun 2020 13:20:32 +0000 (-0400)
Subject: Publish man page changes to RTD
X-Git-Tag: 4.1.1~5
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F22%2F4022%2F1;p=ric-plt%2Flib%2Frmr.git

Publish man page changes to RTD

Man page changes commited earlier were not published. This change
publishes these changes.

Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I056d7f03e05b3fcc633ac6c12962b7ffc4a49aab
---

diff --git a/docs/rmr_wh_close.3.rst b/docs/rmr_wh_close.3.rst
index ac51a12..3741bab 100644
--- a/docs/rmr_wh_close.3.rst
+++ b/docs/rmr_wh_close.3.rst
@@ -30,7 +30,7 @@ SYNOPSIS
  
  #include <rmr/rmr.h>
   
- void rmr_close( void* vctx, rmr_whid_t whid )
+ void rmr_wh_close( void* vctx, rmr_whid_t whid )
  
 
 
diff --git a/docs/rmr_wh_open.3.rst b/docs/rmr_wh_open.3.rst
index 79cabdd..d3a9134 100644
--- a/docs/rmr_wh_open.3.rst
+++ b/docs/rmr_wh_open.3.rst
@@ -30,7 +30,7 @@ SYNOPSIS
  
  #include <rmr/rmr.h>
   
- void* rmr_wh_open( void* vctx, char* target )
+ rmr_whid_t rmr_wh_open( void* vctx, char* target )
  
 
 
@@ -44,10 +44,11 @@ established overtly by the user application (via this
 function), and that the ID returned by ``rmr_wh_open`` be 
 passed to the ``rmr_wh_send_msg`` function. 
  
-*Target* is the *name* or *IP-address* combination of the 
-processes that the wormhole should be connected to. *Vctx* is 
-the RMR void context pointer that was returned by the 
-``rmr_init`` function. 
+*Vctx* is the RMR void context pointer that was returned by 
+the ``rmr_init`` function. *Target* is the *name and port,* 
+or *IP-address and port,* combination for the process that 
+the wormhole should be connected to. For example, 
+"localhost:6123". 
  
 When invoked, this function immediately attempts to connect 
 to the target process. If the connection cannot be 
diff --git a/docs/rmr_wh_send_msg.3.rst b/docs/rmr_wh_send_msg.3.rst
index 8e9a9c2..0849ac2 100644
--- a/docs/rmr_wh_send_msg.3.rst
+++ b/docs/rmr_wh_send_msg.3.rst
@@ -30,7 +30,7 @@ SYNOPSIS
  
  #include <rmr/rmr.h>
   
- rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg );
+ rmr_mbuf_t* rmr_wh_send_msg( void* vctx, rmr_whid_t id, rmr_mbuf_t* msg )
  
 
 
@@ -47,10 +47,12 @@ normal RMR routing based on message type is ignored, and the
 caller may leave the message type unspecified in the message 
 buffer (unless it is needed by the receiving process). 
  
-The message buffer (msg) used to send is the same format as 
-used for regular RMR send and reply to sender operations, 
-thus any buffer allocated by these means, or calls to 
-*rmr_rcv_msg()* can be passed to this function. 
+*Vctx* is the RMR void context pointer that was returned by 
+the ``rmr_init`` function. The message buffer (msg) used to 
+send is the same format as used for regular RMR send and 
+reply to sender operations, thus any buffer allocated by 
+these means, or calls to *rmr_rcv_msg()* can be passed to 
+this function. 
 
 
 Retries