Skip to content

Commit 964f869

Browse files
committed
docs: add MPI_Remove_error_{class,code,string} to docs
Signed-off-by: Thomas Naughton <naughtont@ornl.gov>
1 parent e39f1f9 commit 964f869

File tree

5 files changed

+119
-0
lines changed

5 files changed

+119
-0
lines changed

docs/Makefile.am

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,9 @@ OMPI_MAN3 = \
384384
MPI_Reduce_scatter_block_init.3 \
385385
MPI_Reduce_scatter_init.3 \
386386
MPI_Register_datarep.3 \
387+
MPI_Remove_error_class.3 \
388+
MPI_Remove_error_code.3 \
389+
MPI_Remove_error_string.3 \
387390
MPI_Request_c2f.3 \
388391
MPI_Request_f2c.3 \
389392
MPI_Request_free.3 \
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _mpi_remove_error_class:
2+
3+
4+
MPI_Remove_error_class
5+
======================
6+
7+
.. include_body
8+
9+
:ref:`MPI_Remove_error_class` |mdash| Removes an error class.
10+
11+
.. The following file was automatically generated
12+
.. include:: ./bindings/mpi_remove_error_class.rst
13+
14+
INPUT PARAMETERS
15+
----------------
16+
* ``errorclass``: New error class (integer).
17+
18+
OUTPUT PARAMETERS
19+
-----------------
20+
* ``ierror``: Fortran only: Error status (integer).
21+
22+
DESCRIPTION
23+
-----------
24+
25+
The function :ref:`MPI_Remove_error_class` removes a local error class.
26+
27+
ERRORS
28+
------
29+
30+
.. include:: ./ERRORS.rst
31+
32+
.. seealso::
33+
* :ref:`MPI_Remove_error_code`
34+
* :ref:`MPI_Remove_error_string`
35+
* :ref:`MPI_Error_class`
36+
* :ref:`MPI_Error_string`
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _mpi_remove_error_code:
2+
3+
4+
MPI_Remove_error_code
5+
=====================
6+
7+
.. include_body
8+
9+
:ref:`MPI_Remove_error_code` |mdash| Remove an error code associated with
10+
*errorcode*
11+
12+
.. The following file was automatically generated
13+
.. include:: ./bindings/mpi_remove_error_code.rst
14+
15+
INPUT PARAMETER
16+
---------------
17+
* ``errorcode``: MPI error code (integer).
18+
19+
OUTPUT PARAMETERS
20+
-----------------
21+
* ``ierror``: Fortran only: Error status (integer).
22+
23+
DESCRIPTION
24+
-----------
25+
26+
Removes an error code associated with *errorcode*.
27+
28+
29+
ERRORS
30+
------
31+
32+
.. include:: ./ERRORS.rst
33+
34+
.. seealso::
35+
* :ref:`MPI_Remove_error_class`
36+
* :ref:`MPI_Error_class`
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _mpi_remove_error_string:
2+
3+
4+
MPI_Remove_error_string
5+
=======================
6+
7+
.. include_body
8+
9+
:ref:`MPI_Remove_error_string` |mdash| Removes the error string associated with
10+
an error code.
11+
12+
.. The following file was automatically generated
13+
.. include:: ./bindings/mpi_remove_error_string.rst
14+
15+
INPUT PARAMETERS
16+
----------------
17+
* ``errorcode``: MPI error code, returned by an MPI routine (integer).
18+
19+
OUTPUT PARAMETER
20+
----------------
21+
* ``ierror``: Fortran only: Error status (integer).
22+
23+
DESCRIPTION
24+
-----------
25+
26+
This routine removes an error string associated with an error code.
27+
It is erroneous to call :ref:`MPI_Remove_error_string` for an error value not
28+
generated via :ref:`MPI_Remove_error_code` (e.g., an error
29+
code with a value not greater than MPI_LAST_ERRCODE).
30+
31+
32+
ERRORS
33+
------
34+
35+
.. include:: ./ERRORS.rst
36+
37+
.. seealso::
38+
* :ref:`MPI_Remove_error_class`
39+
* :ref:`MPI_Remove_error_code`
40+
* :ref:`MPI_Error_class`
41+
* :ref:`MPI_Error_string`

docs/man-openmpi/man3/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,9 @@ MPI API manual pages (section 3)
305305
MPI_Reduce_scatter_block_init.3.rst
306306
MPI_Reduce_scatter_init.3.rst
307307
MPI_Register_datarep.3.rst
308+
MPI_Remove_error_class.3.rst
309+
MPI_Remove_error_code.3.rst
310+
MPI_Remove_error_string.3.rst
308311
MPI_Request_c2f.3.rst
309312
MPI_Request_f2c.3.rst
310313
MPI_Request_free.3.rst

0 commit comments

Comments
 (0)