Skip to content

Commit 829e4e7

Browse files
authored
Merge pull request #6111 from kawashima-fj/pr/update-pcoll-doc
README & man: Update pcollreq documentation
2 parents f05ebe8 + 5f0fcf0 commit 829e4e7

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

README

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -869,14 +869,14 @@ Open MPI Extensions
869869

870870
- The following extensions are included in this version of Open MPI:
871871

872-
- pcollreq: Provides routines for persistent collective
873-
communication operations and persistent neighborhood collective
874-
communication operations, which are proposed in the MPI Forum as
875-
of June 2018. The function names are prefixed with MPIX_ instead
876-
of MPI_, like MPIX_Barrier_init, because they are not standardized
877-
yet. Future versions of Open MPI will switch to the MPI_ prefix
878-
once the MPI Standard which includes this feature is published.
879-
See their man page for more details.
872+
- pcollreq: Provides routines for persistent collective communication
873+
operations and persistent neighborhood collective communication
874+
operations, which are planned to be included in the next MPI
875+
Standard after MPI-3.1 as of Nov. 2018. The function names are
876+
prefixed with MPIX_ instead of MPI_, like MPIX_Barrier_init,
877+
because they are not standardized yet. Future versions of Open MPI
878+
will switch to the MPI_ prefix once the MPI Standard which includes
879+
this feature is published. See their man page for more details.
880880
- affinity: Provides the OMPI_Affinity_str() routine on retrieving
881881
a string that contains what resources a process is bound to. See
882882
its man page for more details.

ompi/mpiext/pcollreq/README.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ $COPYRIGHT$
44

55
This extension provides the feature of persistent collective communication
66
operations and persistent neighborhood collective communication operations,
7-
which is proposed in the MPI Forum as of June 2018.
7+
which is planned to be included in the next MPI Standard after MPI-3.1 as
8+
of Nov. 2018.
89

910
See MPIX_Barrier_init(3) for more details.
1011

ompi/mpiext/pcollreq/c/MPIX_Barrier_init.3in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -529,16 +529,16 @@ MPIX_Neighbor_alltoallw_init(\fIsendbuf\fP, \fIsendcounts\fP, \fIsdispls\fP, \fI
529529
.ft R
530530
Creates a persistent communication request for a collective operation or neighborhood collective operation.
531531

532-
As of Sept. 2018, the feature of persistent collective communication operations and persistent collective neighborhood communication operations is planned to be included in the next MPI Standerd after MPI-3.1.
532+
As of Nov. 2018, the feature of persistent collective communication operations and persistent collective neighborhood communication operations is planned to be included in the next MPI Standard after MPI-3.1.
533533
.nf
534534

535535
https://github.com/mpi-forum/mpi-issues/issues/25
536536
.fi
537537

538-
Open MPI implements its draft version shown in the following URL.
538+
Open MPI implements 2018 Draft Specification of the MPI standard shown in the following URL.
539539
.nf
540540

541-
https://github.com/mpi-forum/mpi-issues/files/2078076/mpi32-report-ticket25-austin-vote-june2018.pdf
541+
https://www.mpi-forum.org/docs/drafts/mpi-2018-draft-report.pdf
542542
.fi
543543

544544
The interface may still change in the standard. Therefore the prefix \fIMPIX_\fP is used instead of \fIMPI_\fP for these request creation routines. To start, complete, and free the created request, usual MPI routines (\fIMPI_Start\fP etc.) can be used.

0 commit comments

Comments
 (0)