Skip to content

Commit ed28457

Browse files
zerothijsquyres
authored andcommitted
doc: improved ERRORS.rst
Listified the elements and ensured links were properly set. Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent 6839555 commit ed28457

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

docs/man-openmpi/man3/ERRORS.rst

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,47 @@ with the communication object (e.g., communicator, window, file) is called.
66
If no communication object is associated with the MPI call, then the call is
77
considered attached to MPI_COMM_SELF and will call the associated MPI error
88
handler. When MPI_COMM_SELF is not initialized (i.e., before
9-
MPI_INIT / MPI_INIT_THREAD, after MPI_FINALIZE, or when using the Sessions
9+
:ref:`MPI_Init`/:ref:`MPI_Init_thread`, after :ref:`MPI_Finalize`, or when using the Sessions
1010
Model exclusively) the error raises the initial error handler. The initial
11-
error handler can be changed by calling MPI_COMM_SET_ERRHANDLER on
11+
error handler can be changed by calling :ref:`MPI_Comm_set_errhandler` on
1212
MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI
13-
argument to mpiexec or info key to MPI_COMM_SPAWN[_MULTIPLE].
13+
argument to mpiexec or info key to :ref:`MPI_Comm_spawn`/:ref:`MPI_Comm_spawn_multiple`.
1414
If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN
1515
error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error
1616
handler is called for all other MPI functions.
1717

18-
In the sessions model, the error handler can be set during MPI_Session_init.
18+
In the sessions model, the error handler can be set during :ref:`MPI_Session_init`.
1919

20-
Open MPI includes three predefined error handlers that can be used::
20+
Open MPI includes three predefined error handlers that can be used:
2121

22-
MPI_ERRORS_ARE_FATAL: Causes the program to abort all connected MPI processes.
23-
MPI_ERRORS_ABORT: An error handler that can be invoked on a communicator,
24-
window, file, or session. When called on a communicator, it
25-
acts as if MPI_ABORT was called on that communicator. If
26-
called on a window or file, acts as if MPI_ABORT was called
27-
on a communicator containing the group of processes in the
28-
corresponding window or file. If called on a session,
29-
aborts only the local process.
30-
MPI_ERRORS_RETURN: Returns an error code to the application.
22+
* ``MPI_ERRORS_ARE_FATAL``
23+
Causes the program to abort all connected MPI processes.
24+
* ``MPI_ERRORS_ABORT``
25+
An error handler that can be invoked on a communicator,
26+
window, file, or session. When called on a communicator, it
27+
acts as if :ref:`MPI_Abort` was called on that communicator. If
28+
called on a window or file, acts as if :ref:`MPI_Abort` was called
29+
on a communicator containing the group of processes in the
30+
corresponding window or file. If called on a session,
31+
aborts only the local process.
32+
* ``MPI_ERRORS_RETURN``
33+
Returns an error code to the application.
3134

3235
MPI applications can also implement their own error handlers.
3336

3437
Custom MPI error handlers can be created by calling:
35-
:ref:`MPI_Comm_create_errhandler(3) <MPI_Comm_create_errhandler>`
36-
:ref:`MPI_File_create_errhandler(3) <MPI_File_create_errhandler>`
37-
:ref:`MPI_Session_create_errhandler(3) <MPI_Session_create_errhandler>`
38-
:ref:`MPI_Win_create_errhandler(3) <MPI_Win_create_errhandler>`
38+
39+
* :ref:`MPI_Comm_create_errhandler`
40+
* :ref:`MPI_File_create_errhandler`
41+
* :ref:`MPI_Session_create_errhandler`
42+
* :ref:`MPI_Win_create_errhandler`
3943

4044
Predefined and custom error handlers can be set by calling:
41-
:ref:`MPI_Comm_set_errhandler(3) <MPI_Comm_set_errhandler>`
42-
:ref:`MPI_File_set_errhandler(3) <MPI_File_set_errhandler>`
43-
:ref:`MPI_Session_set_errhandler(3) <MPI_Session_set_errhandler>`
44-
:ref:`MPI_Win_set_errhandler(3) <MPI_Win_set_errhandler>`
45+
46+
* :ref:`MPI_Comm_set_errhandler`
47+
* :ref:`MPI_File_set_errhandler`
48+
* :ref:`MPI_Session_set_errhandler`
49+
* :ref:`MPI_Win_set_errhandler`
4550

4651
Note that MPI does not guarantee that an MPI program can continue past
4752
an error.

0 commit comments

Comments
 (0)