From 64c56683536d7a28b3faa4b900293c7e825f1399 Mon Sep 17 00:00:00 2001 From: Christoph Niethammer Date: Thu, 16 May 2024 10:20:25 +0200 Subject: [PATCH] Correct request and info parameter descriptions for persistent collectives Signed-off-by: Christoph Niethammer --- docs/man-openmpi/man3/MPI_Allgather.3.rst | 2 +- docs/man-openmpi/man3/MPI_Allgatherv.3.rst | 2 +- docs/man-openmpi/man3/MPI_Allreduce.3.rst | 2 +- docs/man-openmpi/man3/MPI_Alltoall.3.rst | 2 +- docs/man-openmpi/man3/MPI_Alltoallv.3.rst | 2 +- docs/man-openmpi/man3/MPI_Alltoallw.3.rst | 2 +- docs/man-openmpi/man3/MPI_Barrier.3.rst | 2 +- docs/man-openmpi/man3/MPI_Exscan.3.rst | 2 +- docs/man-openmpi/man3/MPI_Gather.3.rst | 2 +- docs/man-openmpi/man3/MPI_Gatherv.3.rst | 2 +- docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst | 2 +- docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst | 2 +- docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst | 2 +- docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst | 2 +- docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst | 2 +- docs/man-openmpi/man3/MPI_Reduce.3.rst | 4 ++-- docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst | 4 ++-- docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst | 2 +- docs/man-openmpi/man3/MPI_Scan.3.rst | 2 +- docs/man-openmpi/man3/MPI_Scatter.3.rst | 4 ++-- docs/man-openmpi/man3/MPI_Scatterv.3.rst | 2 +- 21 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/man-openmpi/man3/MPI_Allgather.3.rst b/docs/man-openmpi/man3/MPI_Allgather.3.rst index 44fc8a2c67e..005d260ad4e 100644 --- a/docs/man-openmpi/man3/MPI_Allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgather.3.rst @@ -111,7 +111,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst index efc5ee540b5..de55920894d 100644 --- a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst @@ -116,7 +116,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Allreduce.3.rst b/docs/man-openmpi/man3/MPI_Allreduce.3.rst index c8fb263f1d5..a38f0a98964 100644 --- a/docs/man-openmpi/man3/MPI_Allreduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Allreduce.3.rst @@ -104,7 +104,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Alltoall.3.rst b/docs/man-openmpi/man3/MPI_Alltoall.3.rst index 6de7376154d..6b1c6c459eb 100644 --- a/docs/man-openmpi/man3/MPI_Alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoall.3.rst @@ -116,7 +116,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst index 0f70254204e..bfe8f861b4d 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst @@ -130,7 +130,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status. DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst index 67783b46b2c..2fadb8f8697 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst @@ -133,7 +133,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status. DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Barrier.3.rst b/docs/man-openmpi/man3/MPI_Barrier.3.rst index dcfb87ca77a..c47d6b82cba 100644 --- a/docs/man-openmpi/man3/MPI_Barrier.3.rst +++ b/docs/man-openmpi/man3/MPI_Barrier.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- -* ``request`` : Request (handle, non-blocking only). +* ``request`` : Request (handle, non-blocking and persistent only). * ``ierror`` : Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Exscan.3.rst b/docs/man-openmpi/man3/MPI_Exscan.3.rst index 4fad9c889fa..8289188dff7 100644 --- a/docs/man-openmpi/man3/MPI_Exscan.3.rst +++ b/docs/man-openmpi/man3/MPI_Exscan.3.rst @@ -101,7 +101,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Gather.3.rst b/docs/man-openmpi/man3/MPI_Gather.3.rst index 8cfe7d4c3a8..b3257b9958e 100644 --- a/docs/man-openmpi/man3/MPI_Gather.3.rst +++ b/docs/man-openmpi/man3/MPI_Gather.3.rst @@ -112,7 +112,7 @@ OUTPUT PARAMETERS * ``recvbuf`` : Address of receive buffer (choice, significant only at root). -* ``request`` : Request (handle, non-blocking only). +* ``request`` : Request (handle, non-blocking and persistent only). * ``ierror`` : Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Gatherv.3.rst b/docs/man-openmpi/man3/MPI_Gatherv.3.rst index 6817a969439..beef4e482e9 100644 --- a/docs/man-openmpi/man3/MPI_Gatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Gatherv.3.rst @@ -118,7 +118,7 @@ OUTPUT PARAMETERS * ``recvbuf`` : Address of receive buffer (choice, significant only at root). -* ``request`` : Request (handle, non-blocking only). +* ``request`` : Request (handle, non-blocking and persistent only). * ``ierror`` : Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst index 8bf2e3da04e..1a5e90aee0f 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst @@ -111,7 +111,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst index 541872143ba..0b44d303ed7 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst @@ -117,7 +117,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst index 58c7c76c573..c8d68a2086e 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst @@ -115,7 +115,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst index 1922689eefd..bfa4dcf2f5f 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst @@ -130,7 +130,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status. DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst index 0f14919a8fe..b79361f049c 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst @@ -135,7 +135,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status. DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Reduce.3.rst b/docs/man-openmpi/man3/MPI_Reduce.3.rst index 30f447b8fea..b45d0b7c94a 100644 --- a/docs/man-openmpi/man3/MPI_Reduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce.3.rst @@ -106,12 +106,12 @@ INPUT PARAMETERS * ``op``: Reduce operation (handle). * ``root``: Rank of root process (integer). * ``comm``: Communicator (handle). -* ``info``: Info (handle, persistent). +* ``info``: Info (handle, persistent only). OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice, significant only at root). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst index a4fe9510c2c..01f7287e63a 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst @@ -102,12 +102,12 @@ INPUT PARAMETERS * ``datatype``: Datatype of elements of input buffer (handle). * ``op``: Operation (handle). * ``comm``: Communicator (handle). -* ``info``: Info (handle, persistent). +* ``info``: Info (handle, persistent only). OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst index deb70025f4c..bc9b39d035d 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst @@ -109,7 +109,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Scan.3.rst b/docs/man-openmpi/man3/MPI_Scan.3.rst index 47554ee8b8c..a5b2d1bcfcb 100644 --- a/docs/man-openmpi/man3/MPI_Scan.3.rst +++ b/docs/man-openmpi/man3/MPI_Scan.3.rst @@ -102,7 +102,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Scatter.3.rst b/docs/man-openmpi/man3/MPI_Scatter.3.rst index 9a78a045c36..9c89886a22c 100644 --- a/docs/man-openmpi/man3/MPI_Scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatter.3.rst @@ -106,12 +106,12 @@ INPUT PARAMETERS * ``recvtype``: Datatype of receive buffer elements (handle). * ``root``: Rank of sending process (integer). * ``comm``: Communicator (handle). -* ``info``: Info (handle, persistent). +* ``info``: Info (handle, persistent only). OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION diff --git a/docs/man-openmpi/man3/MPI_Scatterv.3.rst b/docs/man-openmpi/man3/MPI_Scatterv.3.rst index 332df42e604..febc55b4262 100644 --- a/docs/man-openmpi/man3/MPI_Scatterv.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatterv.3.rst @@ -114,7 +114,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). -* ``request``: Request (handle, non-blocking only). +* ``request``: Request (handle, non-blocking and persistent only). * ``ierror``: Fortran only: Error status (integer). DESCRIPTION