Skip to content

Commit 99d7c3c

Browse files
committed
docs: Link to MPI Forum docs web page
Instead of having hard-coded references to old versions of the MPI standard, link out to the MPI Forum web site docs page, and update the cited section of the doc to be something that exists in both the older versions of the MPI standard and also in the current (MPI-4.1) standard. Signed-off-by: Jeff Squyres <jeff@squyres.com>
1 parent 5619144 commit 99d7c3c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/man-openmpi/man3/MPI_Recv.3.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ after the receive buffer contains the newly received message. A receive
7474
can complete before the matching send has completed (of course, it can
7575
complete only after the matching send has started).
7676

77-
The blocking semantics of this call are described in Section 3.4 of the
78-
MPI-1 Standard, "Communication Modes."
77+
The blocking semantics of this call are described in the
78+
"Communication Modes" section of the `MPI Standard
79+
<https://www.mpi-forum.org/docs/>`_.
7980

8081
The receive buffer contains a number (defined by the value of *count*)
8182
of consecutive elements. The first element in the set of elements is
@@ -99,10 +100,11 @@ The *count* argument indicates the maximum number of entries of type
99100
received, use the :ref:`MPI_Get_count` function to determine the actual number
100101
of entries within that message.
101102

102-
To receive messages of unknown length, use the :ref:`MPI_Probe` function. (For
103-
more information about :ref:`MPI_Probe` and :ref:`MPI_Cancel`, see their respective
104-
man pages; also, see Section 3.8 of the MPI-1 Standard, "Probe and
105-
Cancel.")
103+
To receive messages of unknown length, use the :ref:`MPI_Probe`
104+
function. For more information about :ref:`MPI_Probe` and
105+
:ref:`MPI_Cancel`, see their respective man pages and the "Probe and
106+
Cancel" section of the `MPI Standard
107+
<https://www.mpi-forum.org/docs/>`_.
106108

107109
A message can be received by a receive operation only if it is addressed
108110
to the receiving process, and if its source, tag, and communicator
@@ -133,8 +135,9 @@ by the receiver).
133135
Source = destination is allowed, that is, a process can send a message
134136
to itself. However, it is not recommended for a process to send messages
135137
to itself using the blocking send and receive operations described
136-
above, since this may lead to deadlock. See Section 3.5 of the MPI-1
137-
Standard, "Semantics of Point-to-Point Communication."
138+
above, since this may lead to deadlock. See the "Semantics of
139+
Point-to-Point Communication" of the `MPI Standard
140+
<https://www.mpi-forum.org/docs/>`_ for more details.
138141

139142
If your application does not need to examine the *status* field, you can
140143
save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a

0 commit comments

Comments
 (0)