Skip to content

Commit cebad71

Browse files
cniethammercniethammer
authored
Merge pull request open-mpi#12549 from cniethammer/fix-man-pages-persistent-collectives
Fix man pages persistent collectives
2 parents 11e1d8e + 3c8ec54 commit cebad71

22 files changed

+42
-25
lines changed

‎docs/man-openmpi/man3/MPI_Allgather.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ INPUT PARAMETERS
111111
OUTPUT PARAMETERS
112112
-----------------
113113
* ``recvbuf``: Address of receive buffer (choice).
114-
* ``request``: Request (handle, non-blocking only).
114+
* ``request``: Request (handle, non-blocking and persistent only).
115115
* ``ierror``: Fortran only: Error status (integer).
116116

117117
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Allgatherv.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ INPUT PARAMETERS
116116
OUTPUT PARAMETERS
117117
-----------------
118118
* ``recvbuf``: Address of receive buffer (choice).
119-
* ``request``: Request (handle, non-blocking only).
119+
* ``request``: Request (handle, non-blocking and persistent only).
120120
* ``ierror``: Fortran only: Error status (integer).
121121

122122
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Allreduce.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ INPUT PARAMETERS
104104
OUTPUT PARAMETERS
105105
-----------------
106106
* ``recvbuf``: Starting address of receive buffer (choice).
107-
* ``request``: Request (handle, non-blocking only).
107+
* ``request``: Request (handle, non-blocking and persistent only).
108108
* ``ierror``: Fortran only: Error status (integer).
109109

110110
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Alltoall.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ INPUT PARAMETERS
116116
OUTPUT PARAMETERS
117117
-----------------
118118
* ``recvbuf``: Starting address of receive buffer (choice).
119-
* ``request``: Request (handle, non-blocking only).
119+
* ``request``: Request (handle, non-blocking and persistent only).
120120
* ``ierror``: Fortran only: Error status (integer).
121121

122122
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Alltoallv.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ INPUT PARAMETERS
130130
OUTPUT PARAMETERS
131131
-----------------
132132
* ``recvbuf``: Address of receive buffer.
133-
* ``request``: Request (handle, non-blocking only).
133+
* ``request``: Request (handle, non-blocking and persistent only).
134134
* ``ierror``: Fortran only: Error status.
135135

136136
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Alltoallw.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ INPUT PARAMETERS
133133
OUTPUT PARAMETERS
134134
-----------------
135135
* ``recvbuf``: Address of receive buffer.
136-
* ``request``: Request (handle, non-blocking only).
136+
* ``request``: Request (handle, non-blocking and persistent only).
137137
* ``ierror``: Fortran only: Error status.
138138

139139
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Barrier.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ INPUT PARAMETER
6464
OUTPUT PARAMETERS
6565
-----------------
6666

67-
* ``request`` : Request (handle, non-blocking only).
67+
* ``request`` : Request (handle, non-blocking and persistent only).
6868
* ``ierror`` : Fortran only: Error status (integer).
6969

7070
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Bcast.3.rst‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ C Syntax
2424
int MPI_Ibcast(void *buffer, int count, MPI_Datatype datatype,
2525
int root, MPI_Comm comm, MPI_Request *request)
2626
27+
int MPI_Bcast_init(void *buffer, int count, MPI_Datatype datatype,
28+
int root, MPI_Comm comm, MPI_Info info, MPI_Request *request)
29+
2730
Fortran Syntax
2831
^^^^^^^^^^^^^^
2932

@@ -39,6 +42,10 @@ Fortran Syntax
3942
<type> BUFFER(*)
4043
INTEGER COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR
4144
45+
MPI_BCAST_INIT(BUFFER, COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR)
46+
<type> BUFFER(*)
47+
INTEGER COUNT, DATATYPE, ROOT, COMM, INFO, REQUEST, IERROR
48+
4249
Fortran 2008 Syntax
4350
^^^^^^^^^^^^^^^^^^^
4451

@@ -60,6 +67,15 @@ Fortran 2008 Syntax
6067
TYPE(MPI_Request), INTENT(OUT) :: request
6168
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
6269
70+
MPI_Bcast_init(buffer, count, datatype, root, comm, request, ierror)
71+
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: buffer
72+
INTEGER, INTENT(IN) :: count, root
73+
TYPE(MPI_Datatype), INTENT(IN) :: datatype
74+
TYPE(MPI_Comm), INTENT(IN) :: comm
75+
TYPE(MPI_Info), INTENT(IN) :: info
76+
TYPE(MPI_Request), INTENT(OUT) :: request
77+
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
78+
6379
INPUT/OUTPUT PARAMETERS
6480
-----------------------
6581

@@ -68,11 +84,12 @@ INPUT/OUTPUT PARAMETERS
6884
* ``datatype``: Data type of buffer (handle).
6985
* ``root``: Rank of broadcast root (integer).
7086
* ``comm``: Communicator (handle).
87+
* ``info``: Info (handle, persistent only).
7188

7289
OUTPUT PARAMETERS
7390
-----------------
7491

75-
* ``request``: Request (handle, non-blocking only).
92+
* ``request``: Request (handle, non-blocking and persistent only).
7693
* ``ierror``: Fortran only: Error status (integer).
7794

7895
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Exscan.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ INPUT PARAMETERS
101101
OUTPUT PARAMETERS
102102
-----------------
103103
* ``recvbuf``: Receive buffer (choice).
104-
* ``request``: Request (handle, non-blocking only).
104+
* ``request``: Request (handle, non-blocking and persistent only).
105105
* ``ierror``: Fortran only: Error status (integer).
106106

107107
DESCRIPTION

‎docs/man-openmpi/man3/MPI_Gather.3.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ OUTPUT PARAMETERS
112112

113113
* ``recvbuf`` : Address of receive buffer (choice, significant only at
114114
root).
115-
* ``request`` : Request (handle, non-blocking only).
115+
* ``request`` : Request (handle, non-blocking and persistent only).
116116
* ``ierror`` : Fortran only: Error status (integer).
117117

118118
DESCRIPTION

0 commit comments

Comments
 (0)