From: Lott, Christopher (cl778h) <cl778h@att.com>
Date: Wed, 3 Jun 2020 19:42:06 +0000 (-0400)
Subject: Repair minor flaws in wormhole function docs
X-Git-Tag: 4.1.1~6
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=56a5312c71837e727379f627900fc22e46637a6b;p=ric-plt%2Flib%2Frmr.git

Repair minor flaws in wormhole function docs

Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
Change-Id: Ia8c0707c074c424f3380c972f57478473689496e
---

diff --git a/doc/src/man/rmr_wh_close.3.xfm b/doc/src/man/rmr_wh_close.3.xfm
index 0fd388a..57dbeed 100644
--- a/doc/src/man/rmr_wh_close.3.xfm
+++ b/doc/src/man/rmr_wh_close.3.xfm
@@ -38,7 +38,7 @@
 &ex_start
 #include <rmr/rmr.h>
 
-void rmr_close( void* vctx, rmr_whid_t whid )
+void rmr_wh_close( void* vctx, rmr_whid_t whid )
 &ex_end
 
 &uindent
diff --git a/doc/src/man/rmr_wh_open.3.xfm b/doc/src/man/rmr_wh_open.3.xfm
index 7611b21..45a1249 100644
--- a/doc/src/man/rmr_wh_open.3.xfm
+++ b/doc/src/man/rmr_wh_open.3.xfm
@@ -38,7 +38,7 @@
 &ex_start
 #include <rmr/rmr.h>
 
-void* rmr_wh_open( void* vctx, char* target )
+rmr_whid_t rmr_wh_open( void* vctx, char* target )
 &ex_end
 
 &uindent
@@ -51,9 +51,9 @@ by the user application (via this function), and that the ID returned by &cw(rmr
 be passed to the &cw(rmr_wh_send_msg) function.
 
 &space
-&ital(Target) is the &ital(name:port,) or &ital(IP-address:port,) combination of the
-processes that the wormhole should be connected to.
 &ital(Vctx) is the RMR void context pointer that was returned by the &cw(rmr_init) function.
+&ital(Target) is the &ital(name and port,) or &ital(IP-address and port,) combination for
+the process that the wormhole should be connected to.  For example, "localhost:6123".
 
 &space
 When invoked, this function immediately attempts to connect to the target process.
diff --git a/doc/src/man/rmr_wh_send_msg.3.xfm b/doc/src/man/rmr_wh_send_msg.3.xfm
index 4a3fed8..fd82db2 100644
--- a/doc/src/man/rmr_wh_send_msg.3.xfm
+++ b/doc/src/man/rmr_wh_send_msg.3.xfm
@@ -37,7 +37,7 @@
 &ex_start
 #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 )
 &ex_end
 &uindent
 
@@ -51,6 +51,7 @@ ignored, and the caller may leave the message type unspecified in the message bu
 (unless it is needed by the receiving process).
 
 .sp
+&ital(Vctx) is the RMR void context pointer that was returned by the &cw(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 &ital(rmr_rcv_msg()) can be passed to this function.