Skip to content

Commit 6a0b54b

Browse files
committed
docs: add some missing text to MPI_Mrecv/Imrecv
Add text about status to the MPI_Mrecv.3/MPI_Imrecv.3 man pages that exists in other receive-like functions. Signed-off-by: Jeff Squyres <jeff@squyres.com>
1 parent 811ffef commit 6a0b54b

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ canceling the matched message receive would violate MPI message ordering
9090
rules (e.g., if another message matching the same message signature has
9191
matched |mdash| and possibly received |mdash| before this :ref:`MPI_Imrecv` is canceled).
9292

93+
If your application does not need to examine the *status* field, you
94+
can save resources by using the predefined constant
95+
``MPI_STATUS_IGNORE`` as a special value for the *status* argument.
96+
9397

9498
ERRORS
9599
------

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ the call returns immediately with the *status* object set to *source* =
7575
``MPI_PROC_NULL``, *tag* = ``MPI_ANY_TAG``, and *count* = 0, as if a receive
7676
from ``MPI_PROC_NULL`` was issued.
7777

78+
If your application does not need to examine the *status* field, you
79+
can save resources by using the predefined constant
80+
``MPI_STATUS_IGNORE`` as a special value for the *status* argument.
81+
7882

7983
ERRORS
8084
------

0 commit comments

Comments
 (0)