Skip to content

Commit c65da80

Browse files
committed
ulfm-doc: Update to use ERRORS.rst; see-also format, syntax coloring
examples Signed-off-by: Aurélien Bouteiller <bouteill@icl.utk.edu>
1 parent e762975 commit c65da80

File tree

6 files changed

+20
-61
lines changed

6 files changed

+20
-61
lines changed

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

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,15 +121,8 @@ in both the local and the remote groups of *comm* are acknowledged.
121121
ERRORS
122122
------
123123

124-
Almost all MPI routines return an error value; C routines as the value
125-
of the function and Fortran routines in the last argument.
126-
127-
Before the error value is returned, the current MPI error handler is
128-
called. By default, this error handler aborts the MPI job, except for
129-
I/O function errors. The error handler may be changed with
130-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
131-
may be used to cause error values to be returned. Note that MPI does not
132-
guarantee that an MPI program can continue past an error.
124+
.. include:: ./ERRORS.rst
133125

134126
.. seealso::
135-
:ref:`MPIX_Comm_get_failed` :ref:`MPIX_Comm_agree`
127+
* :ref:`MPIX_Comm_get_failed`
128+
* :ref:`MPIX_Comm_agree`

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

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ process in *comm*, all processes raise an error of class MPIX_ERR_PROC_FAILED.
114114
:ref:`MPIX_Comm_agree` users can propagate and synchronize the knowledge
115115
of failures across all MPI processes in *comm*.
116116

117-
::
117+
.. code-block:: c
118118
119119
Comm_get_failed_consistent(MPI_Comm c, MPI_Group * g) {
120120
int rc; int T=1;
@@ -168,15 +168,8 @@ the local and remote groups of the inter-communicator.
168168
ERRORS
169169
------
170170

171-
Almost all MPI routines return an error value; C routines as the value
172-
of the function and Fortran routines in the last argument.
173-
174-
Before the error value is returned, the current MPI error handler is
175-
called. By default, this error handler aborts the MPI job, except for
176-
I/O function errors. The error handler may be changed with
177-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
178-
may be used to cause error values to be returned. Note that MPI does not
179-
guarantee that an MPI program can continue past an error.
171+
.. include:: ./ERRORS.rst
180172

181173
.. seealso::
182-
:ref:`MPIX_Comm_is_revoked` :ref:`MPIX_Comm_ack_failed`
174+
* :ref:`MPIX_Comm_is_revoked`
175+
* :ref:`MPIX_Comm_ack_failed`

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

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,8 @@ groups of *comm*.
9191
ERRORS
9292
------
9393

94-
Almost all MPI routines return an error value; C routines as the value
95-
of the function and Fortran routines in the last argument.
96-
97-
Before the error value is returned, the current MPI error handler is
98-
called. By default, this error handler aborts the MPI job, except for
99-
I/O function errors. The error handler may be changed with
100-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
101-
may be used to cause error values to be returned. Note that MPI does not
102-
guarantee that an MPI program can continue past an error.
94+
.. include:: ./ERRORS.rst
10395

10496
.. seealso::
105-
:ref:`MPIX_Comm_revoke` :ref:`MPIX_Comm_ack_failed`
97+
* :ref:`MPIX_Comm_revoke`
98+
* :ref:`MPIX_Comm_ack_failed`

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,9 @@ and complete with their normal semantics on a revoked communicator.
107107
ERRORS
108108
------
109109

110-
Almost all MPI routines return an error value; C routines as the value
111-
of the function and Fortran routines in the last argument.
112-
113-
Before the error value is returned, the current MPI error handler is
114-
called. By default, this error handler aborts the MPI job, except for
115-
I/O function errors. The error handler may be changed with
116-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
117-
may be used to cause error values to be returned. Note that MPI does not
118-
guarantee that an MPI program can continue past an error.
110+
.. include:: ./ERRORS.rst
119111

120112
.. seealso::
121-
:ref:`MPIX_Comm_revoke` :ref:`MPIX_Comm_agree` :ref:`MPIX_Comm_shrink`
113+
* :ref:`MPIX_Comm_revoke`
114+
* :ref:`MPIX_Comm_agree`
115+
* :ref:`MPIX_Comm_shrink`

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

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,9 @@ sender.
8484
ERRORS
8585
------
8686

87-
Almost all MPI routines return an error value; C routines as the value
88-
of the function and Fortran routines in the last argument.
89-
90-
Before the error value is returned, the current MPI error handler is
91-
called. By default, this error handler aborts the MPI job, except for
92-
I/O function errors. The error handler may be changed with
93-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
94-
may be used to cause error values to be returned. Note that MPI does not
95-
guarantee that an MPI program can continue past an error.
87+
.. include:: ./ERRORS.rst
9688

9789
.. seealso::
98-
:ref:`MPIX_Comm_is_revoked` :ref:`MPIX_Comm_agree` :ref:`MPIX_Comm_shrink`
90+
* :ref:`MPIX_Comm_is_revoked`
91+
* :ref:`MPIX_Comm_agree`
92+
* :ref:`MPIX_Comm_shrink`

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

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,7 @@ MPI operations on *newcomm*.
111111
ERRORS
112112
------
113113

114-
Almost all MPI routines return an error value; C routines as the value
115-
of the function and Fortran routines in the last argument.
116-
117-
Before the error value is returned, the current MPI error handler is
118-
called. By default, this error handler aborts the MPI job, except for
119-
I/O function errors. The error handler may be changed with
120-
:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
121-
may be used to cause error values to be returned. Note that MPI does not
122-
guarantee that an MPI program can continue past an error.
114+
.. include:: ./ERRORS.rst
123115

124116
.. seealso::
125-
:ref:`MPIX_Comm_is_revoked`
117+
* :ref:`MPIX_Comm_is_revoked`

0 commit comments

Comments
 (0)