Release RMR packages at version 4.0.5

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

diff --git a/docs/rmr_init.3.rst b/docs/rmr_init.3.rst
index 2dfdcc8..9cce558 100644 (file)
--- a/docs/rmr_init.3.rst
+++ b/docs/rmr_init.3.rst
@@ -66,9 +66,9 @@ Similarly, the only penality to the application for over
 specifying the normal buffer size might be a larger memory 
 footprint. 
  
 specifying the normal buffer size might be a larger memory 
 footprint. 
  

-*Flags* allows for selection of some RMr options at the time 
+*Flags* allows for selection of some RMR options at the time 

 of initialisation. These are set by ORing RMRFL constants 
 of initialisation. These are set by ORing RMRFL constants 

-from the RMr header file. Currently the following flags are 
+from the RMR header file. Currently the following flags are 

 supported: 
  
  
 supported: 
  
  


@@ -82,7 +82,7 @@ RMRFL_NOTHREAD
    
   The route table collector thread is not to be started. 
   This should only be used by the route table generator 
    
   The route table collector thread is not to be started. 
   This should only be used by the route table generator 

-  application if it is based on RMr. 
+  application if it is based on RMR. 

    
  
 RMRFL_MTCALL 
    
  
 RMRFL_MTCALL 


@@ -117,11 +117,11 @@ additional support is implemented with the *rmr_mt_call()*
 and *rmr_mt_rcv()* function calls. 
  
 Multi-threaded call support requires the user application to 
 and *rmr_mt_rcv()* function calls. 
  
 Multi-threaded call support requires the user application to 

-specifically enable it when RMr is initialised. This is 
+specifically enable it when RMR is initialised. This is 

 necessary because a second, dedicated, receiver thread must 
 be started, and requires all messages to be examined and 
 queued by this thread. The additional overhead is minimal, 
 necessary because a second, dedicated, receiver thread must 
 be started, and requires all messages to be examined and 
 queued by this thread. The additional overhead is minimal, 

-queuing information is all in the RMr message header, but as 
+queuing information is all in the RMR message header, but as 

 an additional process is necessary the user application must 
 "opt in" to this approach. 
  
 an additional process is necessary the user application must 
 "opt in" to this approach. 
  


@@ -327,8 +327,8 @@ RMR_WARNINGS
 RETURN VALUE 
 -------------------------------------------------------------------------------------------- 
  
 RETURN VALUE 
 -------------------------------------------------------------------------------------------- 
  

-The rmr_init function returns a void pointer (a contex if you 
-will) that is passed as the first parameter to nearly all 
+The rmr_init function returns a void pointer (a context if 
+you will) that is passed as the first parameter to nearly all 

 other RMR functions. If rmr_init is unable to properly 
 initialise the environment, NULL is returned and errno is set 
 to an appropriate value. 
 other RMR functions. If rmr_init is unable to properly 
 initialise the environment, NULL is returned and errno is set 
 to an appropriate value.