Skip to content

Commit 377387b

Browse files
committed
MAN: amended suggestions by devreal
Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent 962608d commit 377387b

10 files changed

+18
-18
lines changed

ompi/mpi/man/man3/MPI_Alloc_mem.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ of this memory is returned in the variable \fIbaseptr\fP.
6363

6464
.SH C NOTES
6565
.ft R
66-
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.
66+
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).
6767

6868
.SH FORTRAN NOTES
6969
.ft R

ompi/mpi/man/man3/MPI_Win_allocate.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ elements of type \fItype\fP. The later choice will allow one to use
100100
array indices in RMA calls, and have those scaled correctly to byte
101101
displacements, even in a heterogeneous environment.
102102
.sp
103-
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.
103+
Calling \fBMPI_Win_free\fP will deallocate the memory allocated by \fBMPI_Win_allocate\fP. It is thus erroneous to manually free \fIbaseptr\fP.
104104

105105
.SH C NOTES
106106
.ft R

ompi/mpi/man/man3/MPI_Win_allocate_shared.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ elements of type \fItype\fP. The later choice will allow one to use
123123
array indices in RMA calls, and have those scaled correctly to byte
124124
displacements, even in a heterogeneous environment.
125125
.sp
126-
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.
126+
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.
127127

128128
.SH C NOTES
129129
.ft R

ompi/mpi/man/man3/MPI_Win_create_dynamic.3in

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Fortran only: Error status (integer).
5454
.ft R
5555
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.
5656
.sp
57-
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.
57+
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.
5858

5959
.sp
6060
The following info keys are supported:
@@ -63,18 +63,18 @@ The following info keys are supported:
6363
no_locks
6464
If set to \fItrue\fP, then the implementation may assume that the local
6565
window is never locked (by a call to MPI_Win_lock or
66-
MPI_Win_lock_all). Setting this value if only active synchronization
66+
MPI_Win_lock_all). Setting this value if only active synchronization
6767
may allow the implementation to enable certain optimizations.
6868
.sp
6969
.TP 1i
7070
accumulate_ordering
7171
By default, accumulate operations from one initiator to one target on
72-
the same window are strictly ordered. If the info key
72+
the same window are strictly ordered. If the info key
7373
accumulate_ordering is set to \fInone\fP, no ordering of accumulate
74-
operations guaranteed. They key can also be a comma-separated list of
74+
operations guaranteed. They key can also be a comma-separated list of
7575
required orderings consisting of \fIrar\fP, \fIwar\fP, \fIraw\fP, and \fIwaw\fP for
7676
read-after-read, write-after-read, read-after-write, and
77-
write-after-write, respectively. Looser ordering constraints are
77+
write-after-write, respectively. Looser ordering constraints are
7878
likely to result in improved performance.
7979
.sp
8080
.TP 1i
@@ -83,11 +83,11 @@ If set to \fIsame_op\fP, the implementation will assume that all concurrent
8383
accumulate calls to the same target address will use the same
8484
operation. If set to \fIsame_op_no_op\fP, then the implementation will
8585
assume that all concurrent accumulate calls to the same target address
86-
will use the same operation or MPI_NO_OP. The default is \fIsame_op_no_op\fP.
86+
will use the same operation or \fBMPI_NO_OP\fP. The default is \fIsame_op_no_op\fP.
8787
.sp
8888

8989
.SH NOTES
90-
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.
90+
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.
9191
.sp
9292
Dynamic memory does not have any \fIdisp_unit\fP associated and requires correct offset calculations with proper type handling.
9393
.sp

ompi/mpi/man/man3/MPI_Win_fence.3in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The \fIassert\fP argument is used to provide assertions on the context of the ca
5858
.ft R
5959
.TP 1i
6060
MPI_MODE_NOPRECEDE
61-
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.
61+
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.
6262
.sp
6363
.TP 1i
6464
MPI_MODE_NOSTORE
@@ -68,7 +68,7 @@ MPI_MODE_NOPUT
6868
Informs that the local window will not be updated by any put or accummulate calls in the ensuing epoch (until next fence call).
6969
.TP 1i
7070
MPI_MODE_NOSUCCEED
71-
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.
71+
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.
7272
.sp
7373

7474

ompi/mpi/man/man3/MPI_Win_free.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ MPI_Win_free frees the window object \fIwin\fP and returns a null handle (equal
5050

5151
.SH NOTES
5252
.ft R
53-
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.
53+
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.
5454

5555
.SH ERRORS
5656
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

ompi/mpi/man/man3/MPI_Win_lock.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following assertion value is supported:
6767
.ft R
6868
.TP 1i
6969
MPI_MODE_NOCHECK
70-
No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window.
70+
No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window lock.
7171
.sp
7272

7373
.SH NOTES

ompi/mpi/man/man3/MPI_Win_lock_all.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The following assertion value is supported:
6060
.ft R
6161
.TP 1i
6262
MPI_MODE_NOCHECK
63-
No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window.
63+
No other processes will hold or attempt to acquire a conflicting lock while the caller holds the window lock.
6464
.sp
6565

6666
.SH NOTES

ompi/mpi/man/man3/MPI_Win_post.3in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ Fortran only: Error status (integer).
5656

5757
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.
5858
.sp
59-
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:
59+
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:
6060
.ft R
6161
.TP 1i
6262
MPI_MODE_NOCHECK
63-
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.
63+
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.
6464
.TP 1i
6565
MPI_MODE_NOSTORE
6666
Informs that the local window was not updated by local stores or get calls in the preceding epoch.

ompi/mpi/man/man3/MPI_Win_shared_query.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ all processes in the group attached to the window specified \fIsize\fP
8484

8585
.SH C NOTES
8686
.ft R
87-
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.
87+
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).
8888

8989
.SH ERRORS
9090
Almost all MPI routines return an error value; C routines as the value

0 commit comments

Comments
 (0)