Skip to content

Commit 8463726

Browse files
jsquyresjsquyres
committed
docs: minor additions to the new MPI_Status_* man pages
Also added the new MPI-4.1 MPI_Status_* to the 6.0 changelog. Signed-off-by: Jeff Squyres <[email protected]>
1 parent 3d4c7d4 commit 8463726

7 files changed

+112
-19
lines changed

‎docs/man-openmpi/man3/MPI_Status_get_error.3.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_get_error
66

77
.. include_body
88
9-
:ref:`MPI_Status_get_error` |mdash| Retrieves the MPI_ERROR field from *status*.
9+
:ref:`MPI_Status_get_error` |mdash| Retrieves the ``MPI_ERROR`` field from ``status``.
1010

1111

1212
SYNTAX
@@ -52,16 +52,31 @@ INPUT PARAMETER
5252

5353
OUTPUT PARAMETER
5454
----------------
55-
* ``error``: error set in the MPI_ERROR field (integer).
55+
* ``error``: error set in the ``MPI_ERROR`` field (integer).
5656
* ``ierror``: Fortran only: Error status (integer).
5757

5858
DESCRIPTION
5959
-----------
6060

61-
Returns in error the MPI_ERROR field from the status object.
61+
Returns in error the ``MPI_ERROR`` field from the ``status`` object.
62+
63+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
64+
``MPI_ERROR`` are directly accessible in C and Fortran, for
65+
convenience in other contexts (e.g., when using alternate MPI bindings
66+
in languages that do not directly translate the ``status`` object),
67+
users can also access these values via procedure calls such as this
68+
one.
6269

6370

6471
ERRORS
6572
------
6673

6774
.. include:: ./ERRORS.rst
75+
76+
77+
.. seealso::
78+
* :ref:`MPI_Status_get_source`
79+
* :ref:`MPI_Status_get_tag`
80+
* :ref:`MPI_Status_set_error`
81+
* :ref:`MPI_Status_set_source`
82+
* :ref:`MPI_Status_set_tag`

‎docs/man-openmpi/man3/MPI_Status_get_source.3.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_get_source
66

77
.. include_body
88
9-
:ref:`MPI_Status_get_source` |mdash| Retrieves the MPI_SOURCE field from *status*.
9+
:ref:`MPI_Status_get_source` |mdash| Retrieves the ``MPI_SOURCE`` field from ``status``.
1010

1111

1212
SYNTAX
@@ -53,16 +53,31 @@ INPUT PARAMETER
5353

5454
OUTPUT PARAMETER
5555
----------------
56-
* ``source``: rank set in the MPI_SOURCE field (integer).
56+
* ``source``: rank set in the ``MPI_SOURCE`` field (integer).
5757
* ``ierror``: Fortran only: Error status (integer).
5858

5959
DESCRIPTION
6060
-----------
6161

62-
Returns in source the MPI_SOURCE field from the status object.
62+
Returns in source the ``MPI_SOURCE`` field from the ``status`` object.
63+
64+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
65+
``MPI_ERROR`` are directly accessible in C and Fortran, for
66+
convenience in other contexts (e.g., when using alternate MPI bindings
67+
in languages that do not directly translate the ``status`` object),
68+
users can also access these values via procedure calls such as this
69+
one.
6370

6471

6572
ERRORS
6673
------
6774

6875
.. include:: ./ERRORS.rst
76+
77+
78+
.. seealso::
79+
* :ref:`MPI_Status_get_error`
80+
* :ref:`MPI_Status_get_tag`
81+
* :ref:`MPI_Status_set_error`
82+
* :ref:`MPI_Status_set_source`
83+
* :ref:`MPI_Status_set_tag`

‎docs/man-openmpi/man3/MPI_Status_get_tag.3.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_get_tag
66

77
.. include_body
88
9-
:ref:`MPI_Status_get_tag` |mdash| Retrieves the MPI_TAG field from *status*.
9+
:ref:`MPI_Status_get_tag` |mdash| Retrieves the ``MPI_TAG`` field from ``status``.
1010

1111

1212
SYNTAX
@@ -53,16 +53,31 @@ INPUT PARAMETER
5353

5454
OUTPUT PARAMETER
5555
----------------
56-
* ``tag``: tag set in the MPI_TAG field (integer).
56+
* ``tag``: tag set in the ``MPI_TAG`` field (integer).
5757
* ``ierror``: Fortran only: Error status (integer).
5858

5959
DESCRIPTION
6060
-----------
6161

62-
Returns in tag the MPI_TAG field from the status object.
62+
Returns in tag the ``MPI_TAG`` field from the ``status`` object.
63+
64+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
65+
``MPI_ERROR`` are directly accessible in C and Fortran, for
66+
convenience in other contexts (e.g., when using alternate MPI bindings
67+
in languages that do not directly translate the ``status`` object),
68+
users can also access these values via procedure calls such as this
69+
one.
6370

6471

6572
ERRORS
6673
------
6774

6875
.. include:: ./ERRORS.rst
76+
77+
78+
.. seealso::
79+
* :ref:`MPI_Status_get_error`
80+
* :ref:`MPI_Status_get_source`
81+
* :ref:`MPI_Status_set_error`
82+
* :ref:`MPI_Status_set_source`
83+
* :ref:`MPI_Status_set_tag`

‎docs/man-openmpi/man3/MPI_Status_set_error.3.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_set_error
66

77
.. include_body
88
9-
:ref:`MPI_Status_set_error` |mdash| Sets the MPI_ERROR field on *status*.
9+
:ref:`MPI_Status_set_error` |mdash| Sets the ``MPI_ERROR`` field on ``status``.
1010

1111

1212
SYNTAX
@@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER
5353

5454
INPUT PARAMETER
5555
---------------
56-
* ``error``: error to set in the MPI_ERROR field (integer).
56+
* ``error``: error to set in the ``MPI_ERROR`` field (integer).
5757

5858
OUTPUT PARAMETER
5959
----------------
@@ -62,10 +62,26 @@ OUTPUT PARAMETER
6262
DESCRIPTION
6363
-----------
6464

65-
Set the MPI_ERROR field in the status object to the provided error argument.
65+
Set the ``MPI_ERROR`` field in the ``status`` object to the provided
66+
error argument.
67+
68+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
69+
``MPI_ERROR`` are directly accessible in C and Fortran, for
70+
convenience in other contexts (e.g., when using alternate MPI bindings
71+
in languages that do not directly translate the ``status`` object),
72+
users can also access these values via procedure calls such as this
73+
one.
6674

6775

6876
ERRORS
6977
------
7078

7179
.. include:: ./ERRORS.rst
80+
81+
82+
.. seealso::
83+
* :ref:`MPI_Status_get_error`
84+
* :ref:`MPI_Status_get_source`
85+
* :ref:`MPI_Status_get_tag`
86+
* :ref:`MPI_Status_set_source`
87+
* :ref:`MPI_Status_set_tag`

‎docs/man-openmpi/man3/MPI_Status_set_source.3.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_set_source
66

77
.. include_body
88
9-
:ref:`MPI_Status_set_source` |mdash| Sets the MPI_SOURCE field on *status*.
9+
:ref:`MPI_Status_set_source` |mdash| Sets the ``MPI_SOURCE`` field on ``status``.
1010

1111

1212
SYNTAX
@@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER
5353

5454
INPUT PARAMETER
5555
---------------
56-
* ``source``: rank to set in the MPI_SOURCE field (integer).
56+
* ``source``: rank to set in the ``MPI_SOURCE`` field (integer).
5757

5858
OUTPUT PARAMETER
5959
----------------
@@ -62,10 +62,26 @@ OUTPUT PARAMETER
6262
DESCRIPTION
6363
-----------
6464

65-
Set the MPI_SOURCE field in the status object to the provided source argument.
65+
Set the ``MPI_SOURCE`` field in the ``status`` object to the provided
66+
source argument.
67+
68+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
69+
``MPI_ERROR`` are directly accessible in C and Fortran, for
70+
convenience in other contexts (e.g., when using alternate MPI bindings
71+
in languages that do not directly translate the ``status`` object),
72+
users can also access these values via procedure calls such as this
73+
one.
6674

6775

6876
ERRORS
6977
------
7078

7179
.. include:: ./ERRORS.rst
80+
81+
82+
.. seealso::
83+
* :ref:`MPI_Status_get_error`
84+
* :ref:`MPI_Status_get_source`
85+
* :ref:`MPI_Status_get_tag`
86+
* :ref:`MPI_Status_set_error`
87+
* :ref:`MPI_Status_set_tag`

‎docs/man-openmpi/man3/MPI_Status_set_tag.3.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_Status_set_tag
66

77
.. include_body
88
9-
:ref:`MPI_Status_set_tag` |mdash| Sets the MPI_TAG field on *status*.
9+
:ref:`MPI_Status_set_tag` |mdash| Sets the ``MPI_TAG`` field on ``status``.
1010

1111

1212
SYNTAX
@@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER
5353

5454
INPUT PARAMETER
5555
---------------
56-
* ``tag``: tag to set in the MPI_TAG field (integer).
56+
* ``tag``: tag to set in the ``MPI_TAG`` field (integer).
5757

5858
OUTPUT PARAMETER
5959
----------------
@@ -62,10 +62,26 @@ OUTPUT PARAMETER
6262
DESCRIPTION
6363
-----------
6464

65-
Set the MPI_TAG field in the status object to the provided tag argument.
65+
Set the ``MPI_TAG`` field in the ``status`` object to the provided tag
66+
argument.
67+
68+
While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
69+
``MPI_ERROR`` are directly accessible in C and Fortran, for
70+
convenience in other contexts (e.g., when using alternate MPI bindings
71+
in languages that do not directly translate the ``status`` object),
72+
users can also access these values via procedure calls such as this
73+
one.
6674

6775

6876
ERRORS
6977
------
7078

7179
.. include:: ./ERRORS.rst
80+
81+
82+
.. seealso::
83+
* :ref:`MPI_Status_get_error`
84+
* :ref:`MPI_Status_get_source`
85+
* :ref:`MPI_Status_get_tag`
86+
* :ref:`MPI_Status_set_error`
87+
* :ref:`MPI_Status_set_source`

‎docs/release-notes/changelog/v6.0.x.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Open MPI version v6.0.0
1010

1111
- Open MPI now requires a C11-compliant compiler to build.
1212
- Removed ROMIO package.
13-
13+
- Added MPI-4.1 ``MPI_Status_*`` functions.

0 commit comments

Comments
 (0)