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 <[email protected]>
(cherry picked from commit 97b3a58)

Author: jsquyres

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

@@ -96,6 +96,16 @@ ERRORS
 
 .. include:: ./ERRORS.rst
 
+Note that per the "Return Status" section in the "Point-to-Point
+Communication" chapter in the `MPI Standard
+<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
+by :ref:`MPI_Imrecv` do not set the ``status.MPI_ERROR`` field in the
+returned *status*.  The error code is always passed to the back-end
+error handler and may be passed back to the caller through the return
+value of :ref:`MPI_Imrecv` if the back-end error handler returns it.
+The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
+behavior, for example.
+
 .. seealso::
    * :ref:`MPI_Mprobe`
    * :ref:`MPI_Improbe`

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

@@ -119,6 +119,16 @@ ERRORS
 
 .. include:: ./ERRORS.rst
 
+Note that per the "Return Status" section in the "Point-to-Point
+Communication" chapter in the `MPI Standard
+<https://www.mpi-forum.org/docs/>`_, MPI errors on messages queried
+by :ref:`MPI_Iprobe` do not set the ``status.MPI_ERROR`` field in the
+returned *status*.  The error code is always passed to the back-end
+error handler and may be passed back to the caller through the return
+value of :ref:`MPI_Iprobe` if the back-end error handler returns it.
+The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
+behavior, for example.
+
 .. seealso::
    * :ref:`MPI_Probe`
    * :ref:`MPI_Cancel`

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

@@ -81,6 +81,16 @@ ERRORS
 
 .. include:: ./ERRORS.rst
 
+Note that per the "Return Status" section in the "Point-to-Point
+Communication" chapter in the `MPI Standard
+<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
+by :ref:`MPI_Mrecv` do not set the ``status.MPI_ERROR`` field in the
+returned *status*.  The error code is always passed to the back-end
+error handler and may be passed back to the caller through the return
+value of :ref:`MPI_Mrecv` if the back-end error handler returns it.
+The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
+behavior, for example.
+
 .. seealso::
    * :ref:`MPI_Mprobe`
    * :ref:`MPI_Improbe`

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

@@ -143,6 +143,16 @@ ERRORS
 
 .. include:: ./ERRORS.rst
 
+Note that per the "Return Status" section in the "Point-to-Point
+Communication" chapter in the `MPI Standard
+<https://www.mpi-forum.org/docs/>`_, MPI errors on messages queried
+by :ref:`MPI_Probe` do not set the ``status.MPI_ERROR`` field in the
+returned *status*.  The error code is always passed to the back-end
+error handler and may be passed back to the caller through the return
+value of :ref:`MPI_Probe` if the back-end error handler returns it.
+The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
+behavior, for example.
+
 .. seealso::
    * :ref:`MPI_Iprobe`
    * :ref:`MPI_Cancel`

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

@@ -146,6 +146,16 @@ ERRORS
 
 .. include:: ./ERRORS.rst
 
+Note that per the "Return Status" section in the "Point-to-Point
+Communication" chapter in the `MPI Standard
+<https://www.mpi-forum.org/docs/>`_, MPI errors on messages received
+by :ref:`MPI_Recv` do not set the ``status.MPI_ERROR`` field in the
+returned *status*.  The error code is always passed to the back-end
+error handler and may be passed back to the caller through the return
+value of :ref:`MPI_Recv` if the back-end error handler returns it.
+The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this
+behavior, for example.
+
 .. seealso::
    * :ref:`MPI_Irecv`
    * :ref:`MPI_Probe`

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

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

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

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