Skip to content

docs: minor additions to the new MPI_Status_* man pages #13132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_get_error.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_get_error

.. include_body

:ref:`MPI_Status_get_error` |mdash| Retrieves the MPI_ERROR field from *status*.
:ref:`MPI_Status_get_error` |mdash| Retrieves the ``MPI_ERROR`` field from ``status``.


SYNTAX
Expand Down Expand Up @@ -52,16 +52,38 @@ INPUT PARAMETER

OUTPUT PARAMETER
----------------
* ``error``: error set in the MPI_ERROR field (integer).
* ``error``: error set in the ``MPI_ERROR`` field (integer).
* ``ierror``: Fortran only: Error status (integer).

DESCRIPTION
-----------

Returns in error the MPI_ERROR field from the status object.
Returns in error the ``MPI_ERROR`` field from the ``status`` object.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_source`
* :ref:`MPI_Status_get_tag`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_error`
* :ref:`MPI_Status_set_source`
* :ref:`MPI_Status_set_tag`
* :ref:`MPI_Test_cancelled`
28 changes: 25 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_get_source.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_get_source

.. include_body

:ref:`MPI_Status_get_source` |mdash| Retrieves the MPI_SOURCE field from *status*.
:ref:`MPI_Status_get_source` |mdash| Retrieves the ``MPI_SOURCE`` field from ``status``.


SYNTAX
Expand Down Expand Up @@ -53,16 +53,38 @@ INPUT PARAMETER

OUTPUT PARAMETER
----------------
* ``source``: rank set in the MPI_SOURCE field (integer).
* ``source``: rank set in the ``MPI_SOURCE`` field (integer).
* ``ierror``: Fortran only: Error status (integer).

DESCRIPTION
-----------

Returns in source the MPI_SOURCE field from the status object.
Returns in source the ``MPI_SOURCE`` field from the ``status`` object.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_error`
* :ref:`MPI_Status_get_tag`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_error`
* :ref:`MPI_Status_set_source`
* :ref:`MPI_Status_set_tag`
* :ref:`MPI_Test_cancelled`
28 changes: 25 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_get_tag.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_get_tag

.. include_body

:ref:`MPI_Status_get_tag` |mdash| Retrieves the MPI_TAG field from *status*.
:ref:`MPI_Status_get_tag` |mdash| Retrieves the ``MPI_TAG`` field from ``status``.


SYNTAX
Expand Down Expand Up @@ -53,16 +53,38 @@ INPUT PARAMETER

OUTPUT PARAMETER
----------------
* ``tag``: tag set in the MPI_TAG field (integer).
* ``tag``: tag set in the ``MPI_TAG`` field (integer).
* ``ierror``: Fortran only: Error status (integer).

DESCRIPTION
-----------

Returns in tag the MPI_TAG field from the status object.
Returns in tag the ``MPI_TAG`` field from the ``status`` object.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_error`
* :ref:`MPI_Status_get_source`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_error`
* :ref:`MPI_Status_set_source`
* :ref:`MPI_Status_set_tag`
* :ref:`MPI_Test_cancelled`
29 changes: 26 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_set_error.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_set_error

.. include_body

:ref:`MPI_Status_set_error` |mdash| Sets the MPI_ERROR field on *status*.
:ref:`MPI_Status_set_error` |mdash| Sets the ``MPI_ERROR`` field on ``status``.


SYNTAX
Expand Down Expand Up @@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER

INPUT PARAMETER
---------------
* ``error``: error to set in the MPI_ERROR field (integer).
* ``error``: error to set in the ``MPI_ERROR`` field (integer).

OUTPUT PARAMETER
----------------
Expand All @@ -62,10 +62,33 @@ OUTPUT PARAMETER
DESCRIPTION
-----------

Set the MPI_ERROR field in the status object to the provided error argument.
Set the ``MPI_ERROR`` field in the ``status`` object to the provided
error argument.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_error`
* :ref:`MPI_Status_get_source`
* :ref:`MPI_Status_get_tag`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_source`
* :ref:`MPI_Status_set_tag`
* :ref:`MPI_Test_cancelled`
29 changes: 26 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_set_source.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_set_source

.. include_body

:ref:`MPI_Status_set_source` |mdash| Sets the MPI_SOURCE field on *status*.
:ref:`MPI_Status_set_source` |mdash| Sets the ``MPI_SOURCE`` field on ``status``.


SYNTAX
Expand Down Expand Up @@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER

INPUT PARAMETER
---------------
* ``source``: rank to set in the MPI_SOURCE field (integer).
* ``source``: rank to set in the ``MPI_SOURCE`` field (integer).

OUTPUT PARAMETER
----------------
Expand All @@ -62,10 +62,33 @@ OUTPUT PARAMETER
DESCRIPTION
-----------

Set the MPI_SOURCE field in the status object to the provided source argument.
Set the ``MPI_SOURCE`` field in the ``status`` object to the provided
source argument.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_error`
* :ref:`MPI_Status_get_source`
* :ref:`MPI_Status_get_tag`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_error`
* :ref:`MPI_Status_set_tag`
* :ref:`MPI_Test_cancelled`
29 changes: 26 additions & 3 deletions docs/man-openmpi/man3/MPI_Status_set_tag.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MPI_Status_set_tag

.. include_body

:ref:`MPI_Status_set_tag` |mdash| Sets the MPI_TAG field on *status*.
:ref:`MPI_Status_set_tag` |mdash| Sets the ``MPI_TAG`` field on ``status``.


SYNTAX
Expand Down Expand Up @@ -53,7 +53,7 @@ INPUT/OUTPUT PARAMETER

INPUT PARAMETER
---------------
* ``tag``: tag to set in the MPI_TAG field (integer).
* ``tag``: tag to set in the ``MPI_TAG`` field (integer).

OUTPUT PARAMETER
----------------
Expand All @@ -62,10 +62,33 @@ OUTPUT PARAMETER
DESCRIPTION
-----------

Set the MPI_TAG field in the status object to the provided tag argument.
Set the ``MPI_TAG`` field in the ``status`` object to the provided tag
argument.

While the ``status`` object members ``MPI_SOURCE``, ``MPI_TAG``, and
``MPI_ERROR`` are directly accessible in C and Fortran, for
convenience in other contexts (e.g., when using alternate MPI bindings
in languages that do not directly translate the ``status`` object),
users can also access these values via procedure calls such as this
one.


ERRORS
------

.. include:: ./ERRORS.rst


.. seealso::
* :ref:`MPI_Get_count`
* :ref:`MPI_Get_elements`
* :ref:`MPI_Get_elements_x`
* :ref:`MPI_Status_get_error`
* :ref:`MPI_Status_get_source`
* :ref:`MPI_Status_get_tag`
* :ref:`MPI_Status_set_cancelled`
* :ref:`MPI_Status_set_elements`
* :ref:`MPI_Status_set_elements_x`
* :ref:`MPI_Status_set_error`
* :ref:`MPI_Status_set_source`
* :ref:`MPI_Test_cancelled`
2 changes: 1 addition & 1 deletion docs/release-notes/changelog/v6.0.x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Open MPI version v6.0.0

- Open MPI now requires a C11-compliant compiler to build.
- Removed ROMIO package.

- Added MPI-4.1 ``MPI_Status_*`` functions.