Skip to content

Commit 572cb79

Browse files
committed
Add missing info MPI_Bcast_init API description to docs/man pages
Signed-off-by: Christoph Niethammer <niethammer@hlrs.de>
1 parent 11e1d8e commit 572cb79

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

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

0 commit comments

Comments
 (0)