Fix minor typos in RMR man pages

[ric-plt/lib/rmr.git] / doc / src / man / rmr_rcv_msg.3.xfm

diff --git a/doc/src/man/rmr_rcv_msg.3.xfm b/doc/src/man/rmr_rcv_msg.3.xfm
index c53dcf5..1287ff4 100644 (file)
--- a/doc/src/man/rmr_rcv_msg.3.xfm
+++ b/doc/src/man/rmr_rcv_msg.3.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
 .if false
 ==================================================================================

-       Copyright (c) 2019 Nokia 
-       Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019 Nokia
+   Copyright (c) 2018-2019 AT&T Intellectual Property.

 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.


@@ -17,20 +17,20 @@
 ==================================================================================
 .fi
 .if false
 ==================================================================================
 .fi
 .if false

-       Mnemonic        rmr_rcv_msg_man.xfm
-       Abstract        The manual page for the rmr_rcv_msg function.
-       Author          E. Scott Daniels
-       Date            29 January 2019
+    Mnemonic    rmr_rcv_msg_man.xfm
+    Abstract    The manual page for the rmr_rcv_msg function.
+    Author      E. Scott Daniels
+    Date        29 January 2019

 .fi
 
 .gv e LIB lib
 .fi
 
 .gv e LIB lib

-.im &{lib}/man/setup.im 
+.im &{lib}/man/setup.im

 
 &line_len(6i)
 
 &h1(RMR Library Functions)
 &h2(NAME)
 
 &line_len(6i)
 
 &h1(RMR Library Functions)
 &h2(NAME)

-       rmr_rcv_msg
+    rmr_rcv_msg

 
 &h2(SYNOPSIS )
 &indent
 
 &h2(SYNOPSIS )
 &indent


@@ -44,27 +44,27 @@ rmr_mbuf_t* rmr_rcv_msg( void* vctx, rmr_mbuf_t* old_msg );
 &h2(DESCRIPTION)
 The &cw(rmr_rcv_msg) function blocks until a message is received, returning
 the message to the caller via a pointer to a &cw(rmr_mbuf_t) structure type.
 &h2(DESCRIPTION)
 The &cw(rmr_rcv_msg) function blocks until a message is received, returning
 the message to the caller via a pointer to a &cw(rmr_mbuf_t) structure type.

-If messages were queued while waiting for the response to a previous invocation 
-of &cw(rmr_call,)  the oldest message is removed from the queue and returned 
+If messages were queued while waiting for the response to a previous invocation
+of &cw(rmr_call,)  the oldest message is removed from the queue and returned

 without delay.
 
 &space
 The &ital(vctx) pointer is the pointer returned by the &cw(rmr_init) function.
 without delay.
 
 &space
 The &ital(vctx) pointer is the pointer returned by the &cw(rmr_init) function.

-&ital(Old_msg) is a pointer to a previously used message buffer or NULL. 
+&ital(Old_msg) is a pointer to a previously used message buffer or NULL.

 The ability to reuse message buffers helps to avoid alloc/free cycles in the
 The ability to reuse message buffers helps to avoid alloc/free cycles in the

-user application. 
+user application.

 When no buffer is available to supply, the receive function will allocate one.
 
 &h2(RETURN VALUE)
 The function returns a pointer to the &cw(rmr_mbuf_t) structure which references
 When no buffer is available to supply, the receive function will allocate one.
 
 &h2(RETURN VALUE)
 The function returns a pointer to the &cw(rmr_mbuf_t) structure which references

-the message information (state, length, payload), or a NULL pointer in the case
+the message information (state, length, payload), or a nil pointer in the case

 of an extreme error.
 
 &h2(ERRORS)
 of an extreme error.
 
 &h2(ERRORS)

-The &ital(state) field in the message buffer will indicate either &cw(RMR_OK) 
+The &ital(state) field in the message buffer will indicate &cw(RMR_OK)

 when the message receive process was successful and the message can be used
 by the caller.
 when the message receive process was successful and the message can be used
 by the caller.

-Depending on the underlying transport mechanism, one of the following RMR 
+Depending on the underlying transport mechanism, one of the following RMR

 error stats may be returned:
 &half_space
 
 error stats may be returned:
 &half_space
 


@@ -74,7 +74,7 @@ error stats may be returned:
 &half_space
 &di(RMR_ERR_TIMEOUT) For some transport mechanisms, or if reading the receive
 queue from multiple threads, it is possible for one thread to find no data
 &half_space
 &di(RMR_ERR_TIMEOUT) For some transport mechanisms, or if reading the receive
 queue from multiple threads, it is possible for one thread to find no data

-waiting when it queries the queue.  When this state is reported, the 
+waiting when it queries the queue.  When this state is reported, the

 message buffer does not contain message data and the user application should
 reinvoke the receive function.
 &end_dlist
 message buffer does not contain message data and the user application should
 reinvoke the receive function.
 &end_dlist


@@ -87,7 +87,7 @@ provide more information. The following is a list of possible values that
 might accompany the states listed above:
 
 &half_space
 might accompany the states listed above:
 
 &half_space

-&cw(RMR_ERR_EMPTY) if an empty message was received. 
+&cw(RMR_ERR_EMPTY) if an empty message was received.

 If a nil pointer is returned, or any other state value was set in the message
 buffer,  &cw(errno) will be set to one of the following:
 &space
 If a nil pointer is returned, or any other state value was set in the message
 buffer,  &cw(errno) will be set to one of the following:
 &space