MAN: amended suggestions by devreal

zerothi · zerothi · commit 377387b463b2 · 2021-04-06T11:18:43.000+02:00
Signed-off-by: Nick Papior &lt;nickpapior@gmail.com&gt;
diff --git a/ompi/mpi/man/man3/MPI_Alloc_mem.3in b/ompi/mpi/man/man3/MPI_Alloc_mem.3in
@@ -63,7 +63,7 @@ of this memory is returned in the variable \fIbaseptr\fP.
 
 .SH C NOTES
 .ft R
-While \fIbaseptr\fP is a \fIvoid *\fP type, this is to allow easy use of any pointer object for this parameter. This argument is really a \fIvoid **\fP type.
+The parameter \fIbaseptr\fP is of type \fIvoid *\fP to allow passing any pointer object for this parameter. The provided argument should be a pointer to a pointer of arbitrary type (e.g., \fIvoid **\fP).
 
 .SH FORTRAN NOTES
 .ft R
diff --git a/ompi/mpi/man/man3/MPI_Win_allocate.3in b/ompi/mpi/man/man3/MPI_Win_allocate.3in
@@ -100,7 +100,7 @@ elements of type \fItype\fP. The later choice will allow one to use
 array indices in RMA calls, and have those scaled correctly to byte
 displacements, even in a heterogeneous environment.
 .sp
-Calling \fBMPI_Win_free\fP will deallocate the memory allocated by \fBMPI_Win_allocate\fP. It will thus be an error to manually free \fIbaseptr\fP.
+Calling \fBMPI_Win_free\fP will deallocate the memory allocated by \fBMPI_Win_allocate\fP. It is thus erroneous to manually free \fIbaseptr\fP.
 
 .SH C NOTES
 .ft R
diff --git a/ompi/mpi/man/man3/MPI_Win_allocate_shared.3in b/ompi/mpi/man/man3/MPI_Win_allocate_shared.3in
@@ -123,7 +123,7 @@ elements of type \fItype\fP. The later choice will allow one to use
 array indices in RMA calls, and have those scaled correctly to byte
 displacements, even in a heterogeneous environment.
 .sp
-Calling \fBMPI_Win_free\fP will deallocate the memory allocated by \fBMPI_Win_allocate_shared\fP. It will thus be an error to manually free \fIbaseptr\fP.
+Calling \fBMPI_Win_free\fP will deallocate the memory allocated by \fBMPI_Win_allocate_shared\fP. It is thus erroneous to manually free \fIbaseptr\fP.
 
 .SH C NOTES
 .ft R
diff --git a/ompi/mpi/man/man3/MPI_Win_create_dynamic.3in b/ompi/mpi/man/man3/MPI_Win_create_dynamic.3in
@@ -54,7 +54,7 @@ Fortran only: Error status (integer).
 .ft R
 MPI_Win_create_dynamic is a one-sided MPI communication collective call executed by all processes in the group of \fIcomm\fP. It returns a window object without memory attached that can be used by these processes to perform RMA operations.
 .sp
-A window created with MPI_Win_create_dynamic requires the \fItarget_disp\fP argument for all RMA functions to be the actual address at the target.
+A window created with \fBMPI_Win_create_dynamic\fP requires the \fItarget_disp\fP argument for all RMA communication functions to be the actual address at the target.
 
 .sp
 The following info keys are supported:
@@ -63,18 +63,18 @@ The following info keys are supported:
 no_locks
 If set to \fItrue\fP, then the implementation may assume that the local
 window is never locked (by a call to MPI_Win_lock or
-MPI_Win_lock_all).  Setting this value if only active synchronization
+MPI_Win_lock_all). Setting this value if only active synchronization
 may allow the implementation to enable certain optimizations.
 .sp
 .TP 1i
 accumulate_ordering
 By default, accumulate operations from one initiator to one target on
-the same window are strictly ordered.  If the info key
+the same window are strictly ordered. If the info key
 accumulate_ordering is set to \fInone\fP, no ordering of accumulate
-operations guaranteed.  They key can also be a comma-separated list of
+operations guaranteed. They key can also be a comma-separated list of
 required orderings consisting of \fIrar\fP, \fIwar\fP, \fIraw\fP, and \fIwaw\fP for
 read-after-read, write-after-read, read-after-write, and
-write-after-write, respectively.  Looser ordering constraints are
+write-after-write, respectively. Looser ordering constraints are
 likely to result in improved performance.
 .sp
 .TP 1i
@@ -83,11 +83,11 @@ If set to \fIsame_op\fP, the implementation will assume that all concurrent
 accumulate calls to the same target address will use the same
 operation.  If set to \fIsame_op_no_op\fP, then the implementation will
 assume that all concurrent accumulate calls to the same target address
-will use the same operation or MPI_NO_OP. The default is \fIsame_op_no_op\fP.
+will use the same operation or \fBMPI_NO_OP\fP. The default is \fIsame_op_no_op\fP.
 .sp
 
 .SH NOTES
-Since dynamically attaching memory to windows are not collective calls, one have to communicate the actual address at the target using MPI_Get_address and some communication.
+Since dynamically attaching memory to a window is a local operation, one has to communicate the actual address at the target using \fBMPI_Get_address\fP and some communication.
 .sp
 Dynamic memory does not have any \fIdisp_unit\fP associated and requires correct offset calculations with proper type handling.
 .sp
diff --git a/ompi/mpi/man/man3/MPI_Win_fence.3in b/ompi/mpi/man/man3/MPI_Win_fence.3in
@@ -58,7 +58,7 @@ The \fIassert\fP argument is used to provide assertions on the context of the ca
 .ft R
 .TP 1i
 MPI_MODE_NOPRECEDE
-No locally called RMA calls must be present before this fence. This must be given to all or no members of the window. It may enable faster fence call by bypassing a barrier.
+No local RMA calls have been issued before this fence. This assertion must be provided by all or no members of the group of the window. It may enable faster fence call by avoiding unnecessary synchronization.
 .sp
 .TP 1i
 MPI_MODE_NOSTORE
@@ -68,7 +68,7 @@ MPI_MODE_NOPUT
 Informs that the local window will not be updated by any put or accummulate calls in the ensuing epoch (until next fence call).
 .TP 1i
 MPI_MODE_NOSUCCEED
-No locally called RMA calls must be present after this fence. This must be given to all or no members of the window. It may enable a faster fence call by bypassing a barrier.
+No local RMA calls will be issued after this fence. This assertion must be provided by all or no members of the group of the window. It may enable faster fence call by avoiding unnecessary synchronization.
 .sp
 
 
diff --git a/ompi/mpi/man/man3/MPI_Win_free.3in b/ompi/mpi/man/man3/MPI_Win_free.3in
@@ -50,7 +50,7 @@ MPI_Win_free frees the window object \fIwin\fP and returns a null handle (equal
 
 .SH NOTES
 .ft R
-If the window was created through \fBMPI_Win_allocate\fP or \fBMPI_Win_allocate_shared\fP then the memory buffer from that call would be freed when calling \fBMPI_Win_free\fP.
+If the window was created through \fBMPI_Win_allocate\fP or \fBMPI_Win_allocate_shared\fP then the memory buffer allocated in that call will be freed when calling \fBMPI_Win_free\fP.
 
 .SH ERRORS
 Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
diff --git a/ompi/mpi/man/man3/MPI_Win_lock.3in b/ompi/mpi/man/man3/MPI_Win_lock.3in
@@ -67,7 +67,7 @@ The following assertion value is supported:
 .ft R
 .TP 1i
 MPI_MODE_NOCHECK
-No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window.
+No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window lock.
 .sp
 
 .SH NOTES
diff --git a/ompi/mpi/man/man3/MPI_Win_lock_all.3in b/ompi/mpi/man/man3/MPI_Win_lock_all.3in
@@ -60,7 +60,7 @@ The following assertion value is supported:
 .ft R
 .TP 1i
 MPI_MODE_NOCHECK
-No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window.
+No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window lock.
 .sp
 
 .SH NOTES
diff --git a/ompi/mpi/man/man3/MPI_Win_post.3in b/ompi/mpi/man/man3/MPI_Win_post.3in
@@ -56,11 +56,11 @@ Fortran only: Error status (integer).
 
 Starts an RMA exposure epoch for the local window associated with \fIwin\fP. Only the processes belonging to \fIgroup\fP should access the window with RMA calls on \fIwin\fP during this epoch. Each process in \fIgroup\fP must issue a matching call to MPI_Win_start. MPI_Win_post does not block.
 .sp
-The \fIassert\fP argument is used to provide assertions on the context of the call that may be used for various optimizations. A value of \fIassert\fP = 0 is always valid. The following assertion value is supported:
+The \fIassert\fP argument is used to provide assertions on the context of the call that may be used for various optimizations. A value of \fIassert\fP = 0 is always valid. The following assertion values are supported:
 .ft R
 .TP 1i
 MPI_MODE_NOCHECK
-The matching call MPI_Win_start have not yet occurred ony any origin processes when this call is made. This assertion must be present for all matching MPI_Win_start calls if used.
+The matching calls to MPI_Win_start have not yet occurred on any origin processes when this call is made. This assertion must be present for all matching MPI_Win_start calls if used.
 .TP 1i
 MPI_MODE_NOSTORE
 Informs that the local window was not updated by local stores or get calls in the preceding epoch.
diff --git a/ompi/mpi/man/man3/MPI_Win_shared_query.3in b/ompi/mpi/man/man3/MPI_Win_shared_query.3in
@@ -84,7 +84,7 @@ all processes in the group attached to the window specified \fIsize\fP
 
 .SH C NOTES
 .ft R
-While \fIbaseptr\fP is a \fIvoid *\fP type, this is to allow easy use of any pointer object for this parameter. This argument is really a \fIvoid **\fP type.
+The parameter \fIbaseptr\fP is of type \fIvoid *\fP to allow passing any pointer object for this parameter. The provided argument should be a pointer to a pointer of arbitrary type (e.g. \fIvoid **\fP).
 
 .SH ERRORS
 Almost all MPI routines return an error value; C routines as the value
