Skip to content

Commit

Permalink
Add missing info MPI_Bcast_init API description to docs/man pages
Browse files Browse the repository at this point in the history
Signed-off-by: Christoph Niethammer <[email protected]>
  • Loading branch information
cniethammer authored and hpcraink committed Jul 4, 2024
1 parent a7d42c7 commit 40cb37a
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/man-openmpi/man3/MPI_Bcast.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ C Syntax
int MPI_Ibcast(void *buffer, int count, MPI_Datatype datatype,
int root, MPI_Comm comm, MPI_Request *request)
int MPI_Bcast_init(void *buffer, int count, MPI_Datatype datatype,
int root, MPI_Comm comm, MPI_Info info, MPI_Request *request)
Fortran Syntax
^^^^^^^^^^^^^^

Expand All @@ -39,6 +42,10 @@ Fortran Syntax
<type> BUFFER(*)
INTEGER COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR
MPI_BCAST_INIT(BUFFER, COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR)
<type> BUFFER(*)
INTEGER COUNT, DATATYPE, ROOT, COMM, INFO, REQUEST, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^

Expand All @@ -60,6 +67,15 @@ Fortran 2008 Syntax
TYPE(MPI_Request), INTENT(OUT) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
MPI_Bcast_init(buffer, count, datatype, root, comm, request, ierror)
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: buffer
INTEGER, INTENT(IN) :: count, root
TYPE(MPI_Datatype), INTENT(IN) :: datatype
TYPE(MPI_Comm), INTENT(IN) :: comm
TYPE(MPI_Info), INTENT(IN) :: info
TYPE(MPI_Request), INTENT(OUT) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT/OUTPUT PARAMETERS
-----------------------

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

OUTPUT PARAMETERS
-----------------

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

DESCRIPTION
Expand Down

0 comments on commit 40cb37a

Please sign in to comment.