Skip to content

Commit 97b3a58

Browse files
committed
docs: add note about status to several man pages
Per suggestion from Markus Blatt, add in language similar to what we have in other man pages about how the MPI_ERROR field will not be initialized in the status in the following man pages: * MPI_Imrecv * MPI_Iprobe * MPI_Mrecv * MPI_Probe * MPI_Recv * MPI_Sendrecv * MPI_Sendrecv_replace Signed-off-by: Jeff Squyres <jeff@squyres.com>
1 parent a1b40a4 commit 97b3a58

File tree

7 files changed

+70
-0
lines changed

7 files changed

+70
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,16 @@ ERRORS
9696

9797
.. include:: ./ERRORS.rst
9898

99+
Note that per the "Return Status" section in the "Point-to-Point
100+
Communication" chapter in the `MPI Standard
101+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
102+
by :ref:`MPI_Imrecv` do not set the ``status.MPI_ERROR`` field in the
103+
returned *status*. The error code is always passed to the back-end
104+
error handler and may be passed back to the caller through the return
105+
value of :ref:`MPI_Imrecv` if the back-end error handler returns it.
106+
The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
107+
behavior, for example.
108+
99109
.. seealso::
100110
* :ref:`MPI_Mprobe`
101111
* :ref:`MPI_Improbe`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,16 @@ ERRORS
119119

120120
.. include:: ./ERRORS.rst
121121

122+
Note that per the "Return Status" section in the "Point-to-Point
123+
Communication" chapter in the `MPI Standard
124+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages queried
125+
by :ref:`MPI_Iprobe` do not set the ``status.MPI_ERROR`` field in the
126+
returned *status*. The error code is always passed to the back-end
127+
error handler and may be passed back to the caller through the return
128+
value of :ref:`MPI_Iprobe` if the back-end error handler returns it.
129+
The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
130+
behavior, for example.
131+
122132
.. seealso::
123133
* :ref:`MPI_Probe`
124134
* :ref:`MPI_Cancel`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ ERRORS
8181

8282
.. include:: ./ERRORS.rst
8383

84+
Note that per the "Return Status" section in the "Point-to-Point
85+
Communication" chapter in the `MPI Standard
86+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
87+
by :ref:`MPI_Mrecv` do not set the ``status.MPI_ERROR`` field in the
88+
returned *status*. The error code is always passed to the back-end
89+
error handler and may be passed back to the caller through the return
90+
value of :ref:`MPI_Mrecv` if the back-end error handler returns it.
91+
The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
92+
behavior, for example.
93+
8494
.. seealso::
8595
* :ref:`MPI_Mprobe`
8696
* :ref:`MPI_Improbe`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,16 @@ ERRORS
143143

144144
.. include:: ./ERRORS.rst
145145

146+
Note that per the "Return Status" section in the "Point-to-Point
147+
Communication" chapter in the `MPI Standard
148+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages queried
149+
by :ref:`MPI_Probe` do not set the ``status.MPI_ERROR`` field in the
150+
returned *status*. The error code is always passed to the back-end
151+
error handler and may be passed back to the caller through the return
152+
value of :ref:`MPI_Probe` if the back-end error handler returns it.
153+
The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
154+
behavior, for example.
155+
146156
.. seealso::
147157
* :ref:`MPI_Iprobe`
148158
* :ref:`MPI_Cancel`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,16 @@ ERRORS
146146

147147
.. include:: ./ERRORS.rst
148148

149+
Note that per the "Return Status" section in the "Point-to-Point
150+
Communication" chapter in the `MPI Standard
151+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
152+
by :ref:`MPI_Recv` do not set the ``status.MPI_ERROR`` field in the
153+
returned *status*. The error code is always passed to the back-end
154+
error handler and may be passed back to the caller through the return
155+
value of :ref:`MPI_Recv` if the back-end error handler returns it.
156+
The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
157+
behavior, for example.
158+
149159
.. seealso::
150160
* :ref:`MPI_Irecv`
151161
* :ref:`MPI_Probe`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,5 +116,15 @@ ERRORS
116116

117117
.. include:: ./ERRORS.rst
118118

119+
Note that per the "Return Status" section in the "Point-to-Point
120+
Communication" chapter in the `MPI Standard
121+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
122+
by :ref:`MPI_Sendrecv` do not set the ``status.MPI_ERROR`` field in
123+
the returned *status*. The error code is always passed to the
124+
back-end error handler and may be passed back to the caller through
125+
the return value of :ref:`MPI_Sendrecv` if the back-end error handler
126+
returns it. The pre-defined MPI error handler ``MPI_ERRORS_RETURN``
127+
exhibits this behavior, for example.
128+
119129
.. seealso::
120130
* :ref:`MPI_Sendrecv_replace`

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,5 +112,15 @@ ERRORS
112112

113113
.. include:: ./ERRORS.rst
114114

115+
Note that per the "Return Status" section in the "Point-to-Point
116+
Communication" chapter in the `MPI Standard
117+
<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
118+
by :ref:`MPI_Sendrecv_replace` do not set the ``status.MPI_ERROR``
119+
field in the returned *status*. The error code is always passed to
120+
the back-end error handler and may be passed back to the caller
121+
through the return value of :ref:`MPI_Sendrecv_replace` if the
122+
back-end error handler returns it. The pre-defined MPI error handler
123+
``MPI_ERRORS_RETURN`` exhibits this behavior, for example.
124+
115125
.. seealso::
116126
* :ref:`MPI_Sendrecv`

0 commit comments

Comments
 (0)