diff --git a/docs/man-openmpi/man3/ERRORS.rst b/docs/man-openmpi/man3/ERRORS.rst new file mode 100644 index 00000000000..494ef532bb2 --- /dev/null +++ b/docs/man-openmpi/man3/ERRORS.rst @@ -0,0 +1,53 @@ +Almost all MPI routines return an error value; C routines as the return result +of the function and Fortran routines in the last argument. + +Before the error value is returned, the current MPI error handler associated +with the communication object (e.g., communicator, window, file) is called. +If no communication object is associated with the MPI call, then the call is +considered attached to MPI_COMM_SELF and will call the associated MPI error +handler. When MPI_COMM_SELF is not initialized (i.e., before +MPI_INIT / MPI_INIT_THREAD, after MPI_FINALIZE, or when using the Sessions +Model exclusively) the error raises the initial error handler. The initial +error handler can be changed by calling MPI_COMM_SET_ERRHANDLER on +MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI +argument to mpiexec or info key to MPI_COMM_SPAWN[_MULTIPLE]. +If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN +error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error +handler is called for all other MPI functions. + +In the sessions model, the error handler can be set during MPI_Session_init. + +Open MPI includes three predefined error handlers that can be used:: + + MPI_ERRORS_ARE_FATAL: Causes the program to abort all connected MPI processes. + MPI_ERRORS_ABORT: An error handler that can be invoked on a communicator, + window, file, or session. When called on a communicator, it + acts as if MPI_ABORT was called on that communicator. If + called on a window or file, acts as if MPI_ABORT was called + on a communicator containing the group of processes in the + corresponding window or file. If called on a session, + aborts only the local process. + MPI_ERRORS_RETURN: Returns an error code to the application. + +MPI applications can also implement their own error handlers. + +Custom MPI error handlers can be created by calling: +:ref:`MPI_Comm_create_errhandler(3) ` +:ref:`MPI_File_create_errhandler(3) ` +:ref:`MPI_Session_create_errhandler(3) ` +:ref:`MPI_Win_create_errhandler(3) ` + +Predefined and custom error handlers can be set by calling: +:ref:`MPI_Comm_set_errhandler(3) ` +:ref:`MPI_File_set_errhandler(3) ` +:ref:`MPI_Session_set_errhandler(3) ` +:ref:`MPI_Win_set_errhandler(3) ` + +Note that MPI does not guarantee that an MPI program can continue past +an error. + +See the MPI man page for a full list of MPI error codes. + +See the Error Handling section of the MPI-|mpi_standard_version| standard for +more information. + diff --git a/docs/man-openmpi/man3/MPI_Abort.3.rst b/docs/man-openmpi/man3/MPI_Abort.3.rst index 24d166f443f..c45ffa4f4b7 100644 --- a/docs/man-openmpi/man3/MPI_Abort.3.rst +++ b/docs/man-openmpi/man3/MPI_Abort.3.rst @@ -74,13 +74,4 @@ Note: All associated processes are sent a SIGTERM. ERRORS ------ - -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Accumulate.3.rst b/docs/man-openmpi/man3/MPI_Accumulate.3.rst index 7bf3697b491..3b9da2c2b1c 100644 --- a/docs/man-openmpi/man3/MPI_Accumulate.3.rst +++ b/docs/man-openmpi/man3/MPI_Accumulate.3.rst @@ -169,16 +169,7 @@ arguments in the call to the :ref:`MPI_Accumulate` function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Put` :ref:`MPI_Get_accumulate` :ref:`MPI_Reduce` diff --git a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst index 0df12e8a9dd..129f340b96b 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst @@ -80,16 +80,7 @@ The value returned is always greater than or equal to MPI_ERR_LASTCODE. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Add_error_code` :ref:`MPI_Add_error_string` :ref:`MPI_Error_class` :ref:`MPI_Error_string` diff --git a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst index f853e7dd859..c4fe8f076fe 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst @@ -75,16 +75,7 @@ The value returned is always greater than or equal to MPI_ERR_LASTCODE. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Add_error_class` :ref:`MPI_Error_class` diff --git a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst index fa3a81b9972..abb61d3ac75 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst @@ -72,16 +72,7 @@ code or class with a value not greater than MPI_LAST_ERRCODE). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Add_error_class` :ref:`MPI_Add_error_code` :ref:`MPI_Error_class` :ref:`MPI_Error_string` diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst index 2bae9a3a153..e64c4b2c4ee 100644 --- a/docs/man-openmpi/man3/MPI_Address.3.rst +++ b/docs/man-openmpi/man3/MPI_Address.3.rst @@ -89,16 +89,7 @@ variables guarantees portability to such machines as well. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Get_address` diff --git a/docs/man-openmpi/man3/MPI_Allgather.3.rst b/docs/man-openmpi/man3/MPI_Allgather.3.rst index 7ca3c4e2370..1b655dd626d 100644 --- a/docs/man-openmpi/man3/MPI_Allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgather.3.rst @@ -199,16 +199,7 @@ in the second group. You can move data in only one direction by giving ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Allgatherv` :ref:`MPI_Gather` diff --git a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst index a5c91932e78..81908fbc614 100644 --- a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst @@ -186,16 +186,7 @@ operation must exhibit symmetric, full-duplex behavior. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Gatherv` :ref:`MPI_Allgather` diff --git a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst index 46cec80686c..ca46e42b5ad 100644 --- a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst @@ -112,16 +112,7 @@ User's Guide and are supported by many Fortran compilers. For example, ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Free_mem` diff --git a/docs/man-openmpi/man3/MPI_Allreduce.3.rst b/docs/man-openmpi/man3/MPI_Allreduce.3.rst index bae00545844..868b6de8aa7 100644 --- a/docs/man-openmpi/man3/MPI_Allreduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Allreduce.3.rst @@ -209,12 +209,4 @@ MPI_ERRORS_RETURN , then no error may be indicated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Alltoall.3.rst b/docs/man-openmpi/man3/MPI_Alltoall.3.rst index bbaa119af26..d07d20d06e4 100644 --- a/docs/man-openmpi/man3/MPI_Alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoall.3.rst @@ -193,16 +193,7 @@ functionality to allow the exchange of data with different datatypes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alltoallv` :ref:`MPI_Alltoallw` diff --git a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst index e2d83720428..9684f6d1ad2 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst @@ -213,16 +213,7 @@ where these offsets are measured in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alltoall` :ref:`MPI_Alltoallw` diff --git a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst index 86b585e17f3..ea44f8d5a2a 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst @@ -217,16 +217,7 @@ this to :ref:`MPI_Alltoallv`, where these offsets are measured in units of ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alltoall` :ref:`MPI_Alltoallv` diff --git a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst index 3ebe031d233..6feb661e2d2 100644 --- a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst @@ -75,16 +75,7 @@ being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_delete_attr` diff --git a/docs/man-openmpi/man3/MPI_Attr_get.3.rst b/docs/man-openmpi/man3/MPI_Attr_get.3.rst index 8e345e52b24..4df959328ba 100644 --- a/docs/man-openmpi/man3/MPI_Attr_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_get.3.rst @@ -64,16 +64,7 @@ an erroneous key value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_get_attr` diff --git a/docs/man-openmpi/man3/MPI_Attr_put.3.rst b/docs/man-openmpi/man3/MPI_Attr_put.3.rst index 811f1d28e74..97a768e8d12 100644 --- a/docs/man-openmpi/man3/MPI_Attr_put.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_put.3.rst @@ -80,16 +80,7 @@ the corresponding keyval was created) will be called. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_set_attr` diff --git a/docs/man-openmpi/man3/MPI_Barrier.3.rst b/docs/man-openmpi/man3/MPI_Barrier.3.rst index 10f48de1f9a..cca59bd8bba 100644 --- a/docs/man-openmpi/man3/MPI_Barrier.3.rst +++ b/docs/man-openmpi/man3/MPI_Barrier.3.rst @@ -84,14 +84,6 @@ have entered the barrier. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bcast` diff --git a/docs/man-openmpi/man3/MPI_Bcast.3.rst b/docs/man-openmpi/man3/MPI_Bcast.3.rst index 483490e0348..b7f69869696 100644 --- a/docs/man-openmpi/man3/MPI_Bcast.3.rst +++ b/docs/man-openmpi/man3/MPI_Bcast.3.rst @@ -127,14 +127,4 @@ This function does not support the in-place option. ERRORS ------ - -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Bsend.3.rst b/docs/man-openmpi/man3/MPI_Bsend.3.rst index 08b13068440..aa7872f22cc 100644 --- a/docs/man-openmpi/man3/MPI_Bsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Bsend.3.rst @@ -97,14 +97,4 @@ delivered.) Errors ------ -Almost all MPI routines return an error value; C routines as the value; -C routines as the value of the function and Fortran routines in the last -argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Bsend_init.3.rst b/docs/man-openmpi/man3/MPI_Bsend_init.3.rst index b2f420e79d6..91c9b8c7eae 100644 --- a/docs/man-openmpi/man3/MPI_Bsend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Bsend_init.3.rst @@ -76,15 +76,6 @@ initiated by the function :ref:`MPI_Start`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Send_init` :ref:`MPI_Start` diff --git a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst index 86b547bdd7b..5f1cee7b0c7 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst @@ -86,15 +86,6 @@ Fortran. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Buffer_detach` diff --git a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst index cbafb87e651..9a93189b5af 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst @@ -100,15 +100,6 @@ can return the pointer value. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Buffer_attach` diff --git a/docs/man-openmpi/man3/MPI_Cancel.3.rst b/docs/man-openmpi/man3/MPI_Cancel.3.rst index c11b875913a..3b2db23721e 100644 --- a/docs/man-openmpi/man3/MPI_Cancel.3.rst +++ b/docs/man-openmpi/man3/MPI_Cancel.3.rst @@ -110,14 +110,6 @@ cancel these unsatisfied requests. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Probe` diff --git a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst index 2e70164081c..1d9c479719c 100644 --- a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst @@ -70,12 +70,4 @@ coordinates. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Cart_create.3.rst b/docs/man-openmpi/man3/MPI_Cart_create.3.rst index d2036b875a7..f3294aa88e8 100644 --- a/docs/man-openmpi/man3/MPI_Cart_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_create.3.rst @@ -83,12 +83,4 @@ is erroneous if it specifies a grid that is larger than the group size. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Cart_get.3.rst b/docs/man-openmpi/man3/MPI_Cart_get.3.rst index 63e66725fd3..6c944fe890c 100644 --- a/docs/man-openmpi/man3/MPI_Cart_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_get.3.rst @@ -75,14 +75,6 @@ topology information that was associated with a communicator by Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Cartdim_get` diff --git a/docs/man-openmpi/man3/MPI_Cart_map.3.rst b/docs/man-openmpi/man3/MPI_Cart_map.3.rst index 8de9db8a013..76bb823022a 100644 --- a/docs/man-openmpi/man3/MPI_Cart_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_map.3.rst @@ -77,14 +77,6 @@ the calling process, that is, not to perform any reordering. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_map` diff --git a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst index 39c3e153ffa..53647d9940d 100644 --- a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst @@ -72,14 +72,6 @@ erroneous for nonperiodic dimensions. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst index 0dd22bfd729..ec1b6a0bf3d 100644 --- a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst @@ -118,13 +118,4 @@ dims[i]. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst index 5578472576a..7803b753bdf 100644 --- a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst @@ -86,14 +86,6 @@ one-dimensional Cartesian topology. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst index aa38d6eb461..0371a4d7d3d 100644 --- a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst @@ -63,14 +63,6 @@ structure. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Cart_get` diff --git a/docs/man-openmpi/man3/MPI_Close_port.3.rst b/docs/man-openmpi/man3/MPI_Close_port.3.rst index 27d46e20d11..5629e99e210 100644 --- a/docs/man-openmpi/man3/MPI_Close_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Close_port.3.rst @@ -61,12 +61,4 @@ Description Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst index 7f2bbbb3379..629d7e4226d 100644 --- a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst @@ -74,14 +74,6 @@ through a call to :ref:`MPI_Open_port` on the root. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. See the MPI man page for a full list of MPI -error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_connect` diff --git a/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst index 7722f38427b..c207a0b6948 100644 --- a/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst @@ -72,9 +72,6 @@ processes in comm if the default error handler has not been changed. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. See the MPI -man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst index c10ab1aa6aa..9e23d175b8d 100644 --- a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst @@ -67,12 +67,4 @@ the same but the rank order differs. MPI_UNEQUAL results otherwise. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst index 9bc65aebeb1..9e04b70db1e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst @@ -82,15 +82,6 @@ address of the server. It must be the same as the name returned by Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. See the MPI man page for a full -list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_accept` diff --git a/docs/man-openmpi/man3/MPI_Comm_create.3.rst b/docs/man-openmpi/man3/MPI_Comm_create.3.rst index cb3bb12cf6d..34fd0dcfff1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create.3.rst @@ -82,14 +82,6 @@ service is provided by :ref:`MPI_Comm_split`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_split` diff --git a/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst index fb4e65d43ec..132910748bf 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst @@ -91,12 +91,4 @@ deprecated. In Fortran, the user routine should be of this form: Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the ``function`` and Fortran routines in the last argument. Before -the error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O -``function`` errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst index 4023b25dc5b..b4963f2b47b 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst @@ -94,14 +94,6 @@ shall have a value of at least 63. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_group` diff --git a/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst index c47462261f0..9fa715a5ec7 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst @@ -93,14 +93,6 @@ parallel sub-computations. A more general service is provided by Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create` diff --git a/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst index 2895e2f4ac8..7213c0b3645 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst @@ -129,15 +129,6 @@ length of the declared integer in bytes. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI` diff --git a/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst index ba03c08777e..bd90674731e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst @@ -86,12 +86,4 @@ callback is being invoked. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst index 099ef342c24..6d836151093 100644 --- a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst @@ -78,14 +78,6 @@ processes are completely independent. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_connect` diff --git a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst index c189d875849..e399b9ddba0 100644 --- a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst @@ -86,14 +86,6 @@ the same object on which the attribute copy callback is being invoked. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_dup_with_info` diff --git a/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst index f45bc105793..a193e4e22d3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst @@ -86,14 +86,6 @@ the same object on which the attribute copy callback is being invoked. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_dup` diff --git a/docs/man-openmpi/man3/MPI_Comm_free.3.rst b/docs/man-openmpi/man3/MPI_Comm_free.3.rst index 11747464433..3bc108b61d2 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free.3.rst @@ -78,16 +78,7 @@ being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_delete_attr` diff --git a/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst index 15cedab0d12..19ebc35bd4c 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst @@ -80,13 +80,4 @@ Key values are global (they can be used with any and all communicators). ERRORS ------ - -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst index 93e41df92b6..cbdff53e1a3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst @@ -94,12 +94,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst index 7c63104fab3..2e91c5e29f7 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst @@ -68,14 +68,4 @@ use of which is deprecated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst index ff2077347a3..56dd096bb1d 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst @@ -69,16 +69,7 @@ responsible for freeing info_used via :ref:`MPI_Info_free`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_get_info` :ref:`MPI_Info_free` diff --git a/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst index 11272d0433c..267bd77c7c2 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst @@ -98,13 +98,4 @@ present information in a less cryptic manner. ERRORS ------ - -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst index 5c77b3d1fa6..c7e9bd80b1c 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst @@ -81,16 +81,7 @@ communicator is not useful. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_spawn` :ref:`MPI_Comm_spawn_multiple` diff --git a/docs/man-openmpi/man3/MPI_Comm_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_group.3.rst index fcc630cbdf5..249d2f4a7ab 100644 --- a/docs/man-openmpi/man3/MPI_Comm_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_group.3.rst @@ -66,12 +66,4 @@ To return the remote group, use the :ref:`MPI_Comm_remote_group` function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst index a54eb775a63..37b861c9cea 100644 --- a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst @@ -101,16 +101,7 @@ callback is being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_dup` :ref:`MPI_Comm_dup_with_info` diff --git a/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst index 087d50715af..284841a5483 100644 --- a/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst @@ -104,16 +104,7 @@ callback is being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_dup` :ref:`MPI_Comm_idup` :ref:`MPI_Comm_dup_with_info` diff --git a/docs/man-openmpi/man3/MPI_Comm_join.3.rst b/docs/man-openmpi/man3/MPI_Comm_join.3.rst index dc5743d8746..d825d4cf830 100644 --- a/docs/man-openmpi/man3/MPI_Comm_join.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_join.3.rst @@ -91,18 +91,7 @@ mechanisms. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: socket(3SOCKET) :ref:`MPI_Comm_create` :ref:`MPI_Comm_group` diff --git a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst index 11e403cc042..9d95337652f 100644 --- a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst @@ -74,16 +74,7 @@ the various processes of a communicator. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_group` :ref:`MPI_Comm_size` :ref:`MPI_Comm_compare` diff --git a/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst index 3d068d7af81..a3ca39fb49e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst @@ -69,16 +69,7 @@ The intercommunicator accessors (:ref:`MPI_Comm_test_inter`, ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_test_inter` :ref:`MPI_Comm_remote_size` :ref:`MPI_Intercomm_create` diff --git a/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst b/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst index b52f3720c51..8049a8b21f7 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst @@ -69,16 +69,7 @@ The intercommunicator accessors (:ref:`MPI_Comm_test_inter`, ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_test_inter` :ref:`MPI_Comm_remote_group` :ref:`MPI_Intercomm_create` diff --git a/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst index 0d2645567e2..3616a8a5f67 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst @@ -111,12 +111,4 @@ the corresponding keyval was created) will be called. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst index bdcd7cc635e..00cdad6209f 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst @@ -69,12 +69,4 @@ identical to :ref:`MPI_Errhandler_set`, the use of which is deprecated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst index 44703f55acf..1ecb377b024 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst @@ -92,16 +92,7 @@ were performed by the receiver. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_get_info` :ref:`MPI_Info_create` :ref:`MPI_Info_set` :ref:`MPI_Info_free` diff --git a/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst index 9d85703aec2..0c20e345ccf 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst @@ -97,16 +97,7 @@ will always succeed. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_get_name` diff --git a/docs/man-openmpi/man3/MPI_Comm_size.3.rst b/docs/man-openmpi/man3/MPI_Comm_size.3.rst index b106e04ae21..1cb56390b5a 100644 --- a/docs/man-openmpi/man3/MPI_Comm_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_size.3.rst @@ -84,16 +84,7 @@ MPI_COMM_NULL is not considered a valid argument to this function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_group` :ref:`MPI_Comm_rank` :ref:`MPI_Comm_compare` diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst index 977193fe4de..27b7fa7f470 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst @@ -272,16 +272,7 @@ intercommunicator can be used immediately). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_spawn_multiple` :ref:`MPI_Comm_get_parent` mpirun(1) diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst index 30d0ba350c9..88a079a4896 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst @@ -270,16 +270,7 @@ of calling :ref:`MPI_Comm_spawn` several times. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_spawn` :ref:`MPI_Comm_get_parent` mpirun(1) diff --git a/docs/man-openmpi/man3/MPI_Comm_split.3.rst b/docs/man-openmpi/man3/MPI_Comm_split.3.rst index a9396130595..ef5a423a039 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split.3.rst @@ -122,16 +122,7 @@ the processes in the new communicator. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create` :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_dup` :ref:`MPI_Comm_free` diff --git a/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst b/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst index f144395a367..9a2039ec8d3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst @@ -144,16 +144,7 @@ macro. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create` :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_dup` :ref:`MPI_Comm_free` diff --git a/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst b/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst index e67eed00afb..5b9ec97319c 100644 --- a/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst @@ -97,16 +97,7 @@ The intercommunicator accessors (:ref:`MPI_Comm_test_inter`, ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_remote_group` :ref:`MPI_Comm_remote_size` :ref:`MPI_Intercomm_create` diff --git a/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst b/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst index 767885c7836..2b4858cf7ff 100644 --- a/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst +++ b/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst @@ -114,13 +114,4 @@ arguments in the call to the :ref:`MPI_Compare_and_swap` function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Dims_create.3.rst b/docs/man-openmpi/man3/MPI_Dims_create.3.rst index 7877ea3f5d3..9bf36bc2dbf 100644 --- a/docs/man-openmpi/man3/MPI_Dims_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dims_create.3.rst @@ -105,12 +105,4 @@ order. Array dims is suitable for use as input to routine ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst index 71db0734ec1..56c0ff2ca79 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst @@ -136,16 +136,7 @@ section 2.5.4. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Dist_graph_create_adjacent` :ref:`MPI_Dist_graph_neighbors` diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst index 32189bc1b2a..559c368539c 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst @@ -125,16 +125,7 @@ See MPI-3 section 2.5.4. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Dist_graph_create` :ref:`MPI_Dist_graph_neighbors` diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst index 8a2d4c141ec..52764eaaf63 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst @@ -85,16 +85,7 @@ process with the same rank in comm_old in the creation call. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Dist_graph_neighbors_count` diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst index 9860368b082..ab08500f726 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst @@ -74,16 +74,7 @@ destinations for the calling process. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Dist_graph_neighbors` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst index cd09cb8aef2..f2441b5edf0 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst @@ -85,16 +85,7 @@ that use it are freed. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst index af390182389..82b291d4cf2 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst @@ -65,16 +65,7 @@ deallocated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst index 09f0ebfd4a8..c359a8bb96c 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst @@ -61,16 +61,7 @@ error handler. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst index 4aebea67f3d..9215c7cebc4 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst @@ -57,16 +57,7 @@ with the communicator. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Error_class.3.rst b/docs/man-openmpi/man3/MPI_Error_class.3.rst index ed47097a43c..219c1adcf69 100644 --- a/docs/man-openmpi/man3/MPI_Error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_class.3.rst @@ -65,16 +65,7 @@ onto itself. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Error_string` diff --git a/docs/man-openmpi/man3/MPI_Error_string.3.rst b/docs/man-openmpi/man3/MPI_Error_string.3.rst index 4d0c0f9234f..767d64ce386 100644 --- a/docs/man-openmpi/man3/MPI_Error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_string.3.rst @@ -72,16 +72,7 @@ argument, resultlen. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Error_class` diff --git a/docs/man-openmpi/man3/MPI_Exscan.3.rst b/docs/man-openmpi/man3/MPI_Exscan.3.rst index 08b8a7f39bb..440201b2f65 100644 --- a/docs/man-openmpi/man3/MPI_Exscan.3.rst +++ b/docs/man-openmpi/man3/MPI_Exscan.3.rst @@ -169,18 +169,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Op_create` :ref:`MPI_Reduce` :ref:`MPI_Scan` diff --git a/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst b/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst index d148861993d..e7ce36539d7 100644 --- a/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst +++ b/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst @@ -124,17 +124,7 @@ arguments in the call to the :ref:`MPI_Fetch_and_op` function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Get_accumulate` :ref:`MPI_Reduce` diff --git a/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst index e16de736dd7..418d52287a5 100644 --- a/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst @@ -71,11 +71,7 @@ files is MPI_ERRORS_RETURN. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_File_create_errhandler` :ref:`MPI_File_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_File_close.3.rst b/docs/man-openmpi/man3/MPI_File_close.3.rst index f1f74ccc6da..a22542641f6 100644 --- a/docs/man-openmpi/man3/MPI_File_close.3.rst +++ b/docs/man-openmpi/man3/MPI_File_close.3.rst @@ -66,12 +66,4 @@ with *fh* have completed before calling :ref:`MPI_File_close`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst index 98d35aa701e..8829f1c12b3 100644 --- a/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst @@ -95,12 +95,4 @@ In the Fortran language, the user routine should be of the form: ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_delete.3.rst b/docs/man-openmpi/man3/MPI_File_delete.3.rst index a4840d0bde4..612ac45cd34 100644 --- a/docs/man-openmpi/man3/MPI_File_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_File_delete.3.rst @@ -70,12 +70,4 @@ delete the file with :ref:`MPI_File_delete` if some process has it open, but ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_amode.3.rst b/docs/man-openmpi/man3/MPI_File_get_amode.3.rst index e8734df4bca..18cd358456f 100644 --- a/docs/man-openmpi/man3/MPI_File_get_amode.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_amode.3.rst @@ -67,12 +67,4 @@ the open file *fh.* ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst b/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst index 579eb951660..8b0900d3eae 100644 --- a/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst @@ -70,12 +70,4 @@ enabled; if *flag* is *false,* nonatomic mode is currently enabled. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst b/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst index 844079e6472..498b95e073d 100644 --- a/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst @@ -90,12 +90,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst index 1bda7df7167..a6c368d89e5 100644 --- a/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst @@ -66,12 +66,4 @@ currently associated with file *file*. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_group.3.rst b/docs/man-openmpi/man3/MPI_File_get_group.3.rst index f774af6785b..03a7452a1a4 100644 --- a/docs/man-openmpi/man3/MPI_File_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_group.3.rst @@ -69,12 +69,4 @@ used to open the file associated with *fh.* The group is returned in ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_info.3.rst b/docs/man-openmpi/man3/MPI_File_get_info.3.rst index 474673c0cf5..8df1a61cef5 100644 --- a/docs/man-openmpi/man3/MPI_File_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_info.3.rst @@ -142,12 +142,4 @@ The following hints can be used as values for the *info_used* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_position.3.rst b/docs/man-openmpi/man3/MPI_File_get_position.3.rst index c0338706ff2..8ac6ef5712b 100644 --- a/docs/man-openmpi/man3/MPI_File_get_position.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_position.3.rst @@ -84,12 +84,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst b/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst index 7f4578401b6..35c129456e9 100644 --- a/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst @@ -84,12 +84,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_size.3.rst b/docs/man-openmpi/man3/MPI_File_get_size.3.rst index 90117a28e11..6d05b0dba2a 100644 --- a/docs/man-openmpi/man3/MPI_File_get_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_size.3.rst @@ -85,16 +85,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_File_preallocate` diff --git a/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst b/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst index 713566eab64..380bfe8db04 100644 --- a/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst @@ -107,12 +107,4 @@ corresponding to displacements in memory. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_get_view.3.rst b/docs/man-openmpi/man3/MPI_File_get_view.3.rst index e852416546d..a2ea7619a7e 100644 --- a/docs/man-openmpi/man3/MPI_File_get_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_view.3.rst @@ -95,12 +95,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iread.3.rst b/docs/man-openmpi/man3/MPI_File_iread.3.rst index c434ffb4d54..712f1a0252f 100644 --- a/docs/man-openmpi/man3/MPI_File_iread.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread.3.rst @@ -85,12 +85,4 @@ mode was specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst index a592df4a8e4..9c54e871244 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst @@ -85,12 +85,4 @@ MPI_MODE_SEQUENTIAL mode was specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iread_at.3.rst b/docs/man-openmpi/man3/MPI_File_iread_at.3.rst index 12e8a17b811..39fffd7d2e7 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_at.3.rst @@ -102,12 +102,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst index 9c77ef7edcc..71202a85b9a 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst @@ -103,12 +103,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst b/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst index f0a3b68bbe8..6656eb0807c 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst @@ -82,12 +82,4 @@ processors. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst index 9d5a516d94a..9a674775443 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst @@ -87,12 +87,4 @@ specified when the file was open. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst index 0b33cabc323..6efa599c077 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst @@ -87,12 +87,4 @@ specified when the file was open. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst index 836986672fd..bffb5f1c6bb 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst @@ -107,12 +107,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst index c62a640d591..80656428641 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst @@ -108,12 +108,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst index be31be9acb8..c0677a4706d 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst @@ -80,12 +80,4 @@ methods of synchronization to impose a particular order. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_open.3.rst b/docs/man-openmpi/man3/MPI_File_open.3.rst index a9bebd729f1..c62d4ae5296 100644 --- a/docs/man-openmpi/man3/MPI_File_open.3.rst +++ b/docs/man-openmpi/man3/MPI_File_open.3.rst @@ -190,12 +190,4 @@ The following hints can be used as values for the *info* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst index 386a6106c6c..2c3b33e118b 100644 --- a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst +++ b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst @@ -116,12 +116,4 @@ or by performing a read or write to certain bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read.3.rst b/docs/man-openmpi/man3/MPI_File_read.3.rst index 97f5936b56c..b32e0ed2859 100644 --- a/docs/man-openmpi/man3/MPI_File_read.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read.3.rst @@ -84,12 +84,4 @@ specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_all.3.rst index f03525060b8..a442cc73635 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all.3.rst @@ -84,12 +84,4 @@ specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst index 924ce738e8d..9e2cf5c9809 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst @@ -90,12 +90,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst index 77fa8022433..93442273b80 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst @@ -85,12 +85,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_at.3.rst b/docs/man-openmpi/man3/MPI_File_read_at.3.rst index 5eb63ae3368..802c7c504a0 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at.3.rst @@ -102,12 +102,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst index ffd38c825cf..9503d65b208 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst @@ -103,12 +103,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst index b6c2cbf7dfe..709f27e46a4 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst @@ -107,12 +107,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst index d5ded8f06c5..886afc0f20c 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst @@ -84,12 +84,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst index 745bb165e79..666abeed834 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst @@ -86,12 +86,4 @@ data requested by all processes of the group. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst index 097e701933b..44e50b11945 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst @@ -94,12 +94,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst index 1713fc9b72e..9f491027caf 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst @@ -89,12 +89,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_read_shared.3.rst b/docs/man-openmpi/man3/MPI_File_read_shared.3.rst index 3f74db534d4..22f4359cc42 100644 --- a/docs/man-openmpi/man3/MPI_File_read_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_shared.3.rst @@ -80,12 +80,4 @@ for this noncollective routine. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_seek.3.rst b/docs/man-openmpi/man3/MPI_File_seek.3.rst index eaf3605adee..44ef986ab18 100644 --- a/docs/man-openmpi/man3/MPI_File_seek.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek.3.rst @@ -97,12 +97,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst b/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst index 24d1ca916a0..f31c76a7759 100644 --- a/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst @@ -104,12 +104,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst b/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst index 74b8d652a06..4e4b67b791d 100644 --- a/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst @@ -74,12 +74,4 @@ SMP. For more information, see the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst index 4a20f34ad36..da6f4a4b906 100644 --- a/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst @@ -70,12 +70,4 @@ a predefined error handler or an error handler created by a call to ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_set_info.3.rst b/docs/man-openmpi/man3/MPI_File_set_info.3.rst index d532ba20b99..ed71d0d9c79 100644 --- a/docs/man-openmpi/man3/MPI_File_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_info.3.rst @@ -140,12 +140,4 @@ The following hints can be used as values for the *info* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_set_size.3.rst b/docs/man-openmpi/man3/MPI_File_set_size.3.rst index 2642898dc34..fa6658d0ee3 100644 --- a/docs/man-openmpi/man3/MPI_File_set_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_size.3.rst @@ -99,12 +99,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_set_view.3.rst b/docs/man-openmpi/man3/MPI_File_set_view.3.rst index b2ff3e67008..89fb92fe79f 100644 --- a/docs/man-openmpi/man3/MPI_File_set_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_view.3.rst @@ -180,12 +180,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_sync.3.rst b/docs/man-openmpi/man3/MPI_File_sync.3.rst index dcca6543919..5f249550ea8 100644 --- a/docs/man-openmpi/man3/MPI_File_sync.3.rst +++ b/docs/man-openmpi/man3/MPI_File_sync.3.rst @@ -72,12 +72,4 @@ erroneous. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write.3.rst b/docs/man-openmpi/man3/MPI_File_write.3.rst index 81775780f04..bd465228d5a 100644 --- a/docs/man-openmpi/man3/MPI_File_write.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write.3.rst @@ -88,12 +88,4 @@ specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_all.3.rst index 806eb29e5c6..ee2545085a0 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all.3.rst @@ -84,12 +84,4 @@ specified when the file was opened. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst index d7595b867ef..778fc14872d 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst @@ -90,12 +90,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst index d0126a55364..73dc77a421f 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst @@ -88,12 +88,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_at.3.rst b/docs/man-openmpi/man3/MPI_File_write_at.3.rst index 2592bd35bc3..352b31ff30e 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at.3.rst @@ -103,16 +103,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_File_iwrite_at` :ref:`MPI_File_write_at_all` :ref:`MPI_File_write_at_all_begin` diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst index 56315e534ba..6f1c125d31b 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst @@ -103,12 +103,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst index 62e3734e8f8..cf1a32b450f 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst @@ -108,12 +108,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst index fc8bb431c1c..5130d485644 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst @@ -86,12 +86,4 @@ Section 9.4.5 of the MPI-2 standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst index 02130e44788..c9309251d79 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst @@ -84,12 +84,4 @@ the group. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that -MPI does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst index 58c249269a7..c8ed750cc64 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst @@ -92,12 +92,4 @@ Section 9.4.5 of the MPI-2 standard. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that -MPI does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst index 28b33aeb7e6..bbfee3997ea 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst @@ -83,12 +83,4 @@ Section 9.4.5 of the MPI-2 standard. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that -MPI does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_File_write_shared.3.rst b/docs/man-openmpi/man3/MPI_File_write_shared.3.rst index cdea8ed02db..ef6e78d2f48 100644 --- a/docs/man-openmpi/man3/MPI_File_write_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_shared.3.rst @@ -76,12 +76,4 @@ deterministic for this noncollective routine. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that -MPI does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Finalize.3.rst b/docs/man-openmpi/man3/MPI_Finalize.3.rst index 32c28ee047d..0ba1d94967f 100644 --- a/docs/man-openmpi/man3/MPI_Finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalize.3.rst @@ -98,15 +98,6 @@ MPI_COMM_SELF, the results of :ref:`MPI_Finalize` are not specified. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` diff --git a/docs/man-openmpi/man3/MPI_Finalized.3.rst b/docs/man-openmpi/man3/MPI_Finalized.3.rst index 39fb61f0e74..9b5005f353b 100644 --- a/docs/man-openmpi/man3/MPI_Finalized.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalized.3.rst @@ -59,14 +59,6 @@ another). Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` diff --git a/docs/man-openmpi/man3/MPI_Free_mem.3.rst b/docs/man-openmpi/man3/MPI_Free_mem.3.rst index a186cb9d89f..e029d55f680 100644 --- a/docs/man-openmpi/man3/MPI_Free_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Free_mem.3.rst @@ -61,15 +61,6 @@ Description Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alloc_mem` diff --git a/docs/man-openmpi/man3/MPI_Gather.3.rst b/docs/man-openmpi/man3/MPI_Gather.3.rst index d47d0dae6bb..202f6262765 100644 --- a/docs/man-openmpi/man3/MPI_Gather.3.rst +++ b/docs/man-openmpi/man3/MPI_Gather.3.rst @@ -219,15 +219,6 @@ process in the second group. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. See the MPI man page for a full -list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Gatherv` diff --git a/docs/man-openmpi/man3/MPI_Gatherv.3.rst b/docs/man-openmpi/man3/MPI_Gatherv.3.rst index a10629291a7..7ae9f4385d4 100644 --- a/docs/man-openmpi/man3/MPI_Gatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Gatherv.3.rst @@ -301,15 +301,6 @@ process in the second group. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Gather` diff --git a/docs/man-openmpi/man3/MPI_Get.3.rst b/docs/man-openmpi/man3/MPI_Get.3.rst index 146a80a29a3..96c2b1a82c5 100644 --- a/docs/man-openmpi/man3/MPI_Get.3.rst +++ b/docs/man-openmpi/man3/MPI_Get.3.rst @@ -128,15 +128,6 @@ length of the declared integer in bytes. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Put` diff --git a/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst b/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst index 4d43a7284e2..8d0a1d71db0 100644 --- a/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst @@ -188,15 +188,6 @@ arguments in the call to the :ref:`MPI_Get_accumulate` function. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Put` :ref:`MPI_Reduce` diff --git a/docs/man-openmpi/man3/MPI_Get_address.3.rst b/docs/man-openmpi/man3/MPI_Get_address.3.rst index f4f1e99b057..f2d420c64d3 100644 --- a/docs/man-openmpi/man3/MPI_Get_address.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_address.3.rst @@ -87,13 +87,4 @@ support KIND declarations. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Get_count.3.rst b/docs/man-openmpi/man3/MPI_Get_count.3.rst index eee531dd17e..03f0fd56944 100644 --- a/docs/man-openmpi/man3/MPI_Get_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_count.3.rst @@ -82,18 +82,9 @@ MPI_UNDEFINED is returned instead. Errors ------ +.. include:: ./ERRORS.rst + If the value to be returned is larger than can fit into the count parameter, an MPI_ERR_TRUNCATE error is raised. -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - - .. seealso:: :ref:`MPI_Get_elements` diff --git a/docs/man-openmpi/man3/MPI_Get_elements.3.rst b/docs/man-openmpi/man3/MPI_Get_elements.3.rst index c536e55bbde..21b5d9903c9 100644 --- a/docs/man-openmpi/man3/MPI_Get_elements.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_elements.3.rst @@ -112,15 +112,7 @@ used with primitive data types. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst Fortran 77 Notes ---------------- diff --git a/docs/man-openmpi/man3/MPI_Get_library_version.3.rst b/docs/man-openmpi/man3/MPI_Get_library_version.3.rst index c36a80b8594..cee897f87c3 100644 --- a/docs/man-openmpi/man3/MPI_Get_library_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_library_version.3.rst @@ -78,15 +78,6 @@ before :ref:`MPI_Init` and after :ref:`MPI_Finalize`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Get_version` diff --git a/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst b/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst index 6b3dce2ff34..8fed05b3a53 100644 --- a/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst @@ -74,13 +74,4 @@ actual length of the ``name``. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Get_version.3.rst b/docs/man-openmpi/man3/MPI_Get_version.3.rst index 93f420c7255..d9135148e4c 100644 --- a/docs/man-openmpi/man3/MPI_Get_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_version.3.rst @@ -66,13 +66,4 @@ before :ref:`MPI_Init` and after :ref:`MPI_Finalize`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Graph_create.3.rst b/docs/man-openmpi/man3/MPI_Graph_create.3.rst index 3638b2543ca..894589792ee 100644 --- a/docs/man-openmpi/man3/MPI_Graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_create.3.rst @@ -124,15 +124,6 @@ the list of neighbors of node i, i > 0, is stored in edges(j), index(i) Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_get` diff --git a/docs/man-openmpi/man3/MPI_Graph_get.3.rst b/docs/man-openmpi/man3/MPI_Graph_get.3.rst index 5f59c9d1dbc..daacb9f3db8 100644 --- a/docs/man-openmpi/man3/MPI_Graph_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_get.3.rst @@ -74,15 +74,6 @@ the vectors index and edges correctly for a call to :ref:`MPI_Graph_get`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_create` diff --git a/docs/man-openmpi/man3/MPI_Graph_map.3.rst b/docs/man-openmpi/man3/MPI_Graph_map.3.rst index 4dfe79f49b9..c43af11a577 100644 --- a/docs/man-openmpi/man3/MPI_Graph_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_map.3.rst @@ -71,15 +71,6 @@ capability other than that provided by MPI. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Cart_map` diff --git a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst index f03f5b276d2..2fd35ea4530 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst @@ -108,16 +108,7 @@ and performs an appropriate permutation for each. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_neighbors_count` diff --git a/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst b/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst index cdfc4d739f3..9098a16a747 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst @@ -67,15 +67,6 @@ returns the number of neighbors for the process signified by rank. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_neighbors` diff --git a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst index eb106210fd9..66df25cf5ff 100644 --- a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst @@ -68,15 +68,6 @@ the vectors index and edges correctly for a call to :ref:`MPI_Graph_get`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_create` diff --git a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst index d6af9bf02b3..bb8e01074ed 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst @@ -79,13 +79,4 @@ defined operations. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst index 85f3bb91c79..63d6f3dd648 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst @@ -192,16 +192,7 @@ length of the declared integer in bytes. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst All callback functions return an error code. The code is passed back and dealt with as appropriate for the error code by the MPI function that @@ -219,5 +210,3 @@ error code returned by the corresponding invocation of its ``free_fn`` callback function. However, if the MPI function was passed MPI_STATUSES_IGNORE, then the individual error codes returned by each callback function will be lost. - -See the MPI man page for a full list of MPI error codes. diff --git a/docs/man-openmpi/man3/MPI_Group_compare.3.rst b/docs/man-openmpi/man3/MPI_Group_compare.3.rst index f84ca2690da..c900b44d2fe 100644 --- a/docs/man-openmpi/man3/MPI_Group_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_compare.3.rst @@ -69,13 +69,4 @@ otherwise. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Group_difference.3.rst b/docs/man-openmpi/man3/MPI_Group_difference.3.rst index 9650acc3e3a..ae1f50d20ac 100644 --- a/docs/man-openmpi/man3/MPI_Group_difference.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_difference.3.rst @@ -77,15 +77,6 @@ The new group can be empty, that is, equal to MPI_GROUP_EMPTY. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Group_excl.3.rst b/docs/man-openmpi/man3/MPI_Group_excl.3.rst index ecbde59543a..7ca170d89fb 100644 --- a/docs/man-openmpi/man3/MPI_Group_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_excl.3.rst @@ -79,15 +79,6 @@ This restriction is per the draft. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_range_excl` diff --git a/docs/man-openmpi/man3/MPI_Group_free.3.rst b/docs/man-openmpi/man3/MPI_Group_free.3.rst index 20420e851cb..401ab75eb3e 100644 --- a/docs/man-openmpi/man3/MPI_Group_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_free.3.rst @@ -66,13 +66,4 @@ On return, ``group`` is set to MPI_GROUP_NULL. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst b/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst index 1e460f48763..a9706147bc9 100644 --- a/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst @@ -77,16 +77,6 @@ function. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Group_incl.3.rst b/docs/man-openmpi/man3/MPI_Group_incl.3.rst index 789c773d062..780f6c3b996 100644 --- a/docs/man-openmpi/man3/MPI_Group_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_incl.3.rst @@ -81,15 +81,6 @@ duplicates in the list of ranks. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_compare` diff --git a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst index d01ea7f19cb..b1d7c6d7777 100644 --- a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst @@ -78,15 +78,6 @@ The new group can be empty, that is, equal to MPI_GROUP_EMPTY. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst b/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst index aaf4f20e963..3501ecfbbcb 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst @@ -77,16 +77,7 @@ passing the resulting array of ranks and other arguments to ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_excl` :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst b/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst index 27c7a9b09c8..8617bd7de53 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst @@ -104,16 +104,7 @@ ranges to include are valid ranks in the group. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_incl` :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Group_rank.3.rst b/docs/man-openmpi/man3/MPI_Group_rank.3.rst index fc7bb0719ef..61b9b687b87 100644 --- a/docs/man-openmpi/man3/MPI_Group_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_rank.3.rst @@ -67,12 +67,4 @@ MPI_UNDEFINED is returned. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Group_size.3.rst b/docs/man-openmpi/man3/MPI_Group_size.3.rst index 9c860d0524f..80fae554904 100644 --- a/docs/man-openmpi/man3/MPI_Group_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_size.3.rst @@ -66,12 +66,4 @@ the other hand, a call with group = MPI_GROUP_NULL is erroneous. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst b/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst index 27b0d9fb30e..fbe3fb5fbe6 100644 --- a/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst @@ -74,12 +74,4 @@ want to know their ranks in a subset of that group. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Group_union.3.rst b/docs/man-openmpi/man3/MPI_Group_union.3.rst index 586104ac25a..d1fc92de9cf 100644 --- a/docs/man-openmpi/man3/MPI_Group_union.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_union.3.rst @@ -79,16 +79,7 @@ The new group can be empty, that is, equal to MPI_GROUP_EMPTY. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Ibsend.3.rst b/docs/man-openmpi/man3/MPI_Ibsend.3.rst index a159353626c..1b68f86546d 100644 --- a/docs/man-openmpi/man3/MPI_Ibsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ibsend.3.rst @@ -82,16 +82,7 @@ completes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Test` :ref:`MPI_Wait` diff --git a/docs/man-openmpi/man3/MPI_Improbe.3.rst b/docs/man-openmpi/man3/MPI_Improbe.3.rst index ffd1e4b2f94..5176d65a61e 100644 --- a/docs/man-openmpi/man3/MPI_Improbe.3.rst +++ b/docs/man-openmpi/man3/MPI_Improbe.3.rst @@ -90,16 +90,7 @@ and can be received by passing the *message* handle to the :ref:`MPI_Mrecv` or ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Mprobe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Mrecv` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Imrecv.3.rst b/docs/man-openmpi/man3/MPI_Imrecv.3.rst index 1d3a49d102f..0da440f718c 100644 --- a/docs/man-openmpi/man3/MPI_Imrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Imrecv.3.rst @@ -94,16 +94,7 @@ matched -- and possible received -- before this :ref:`MPI_Imrecv` is canceled). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Mprobe` :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Info_create.3.rst b/docs/man-openmpi/man3/MPI_Info_create.3.rst index 61b05ca4222..a9afe731e19 100644 --- a/docs/man-openmpi/man3/MPI_Info_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create.3.rst @@ -60,16 +60,7 @@ contains no key/value pairs. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_create_env.3.rst b/docs/man-openmpi/man3/MPI_Info_create_env.3.rst index ce4d9973e7b..21ae8f84d08 100644 --- a/docs/man-openmpi/man3/MPI_Info_create_env.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create_env.3.rst @@ -65,16 +65,7 @@ before :ref:`MPI_Init` and after :ref:`MPI_Finalize`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_delete.3.rst b/docs/man-openmpi/man3/MPI_Info_delete.3.rst index 2db22d3887d..66ea290925b 100644 --- a/docs/man-openmpi/man3/MPI_Info_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_delete.3.rst @@ -69,16 +69,7 @@ defined in *info*, the call raises an error of class MPI_ERR_INFO_NOKEY. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_dup.3.rst b/docs/man-openmpi/man3/MPI_Info_dup.3.rst index 0c80fe6b16b..4137f29cc32 100644 --- a/docs/man-openmpi/man3/MPI_Info_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_dup.3.rst @@ -65,16 +65,7 @@ with the same (key,value) pairs and the same ordering of keys. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_free.3.rst b/docs/man-openmpi/man3/MPI_Info_free.3.rst index 4e44e42e6cc..453ce188804 100644 --- a/docs/man-openmpi/man3/MPI_Info_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_free.3.rst @@ -62,16 +62,7 @@ DESCRIPTION ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_get` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_get.3.rst b/docs/man-openmpi/man3/MPI_Info_get.3.rst index a40219a0598..651a5f1860e 100644 --- a/docs/man-openmpi/man3/MPI_Info_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get.3.rst @@ -81,16 +81,7 @@ If *key* is larger than MPI_MAX_INFO_KEY, the call is erroneous. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` diff --git a/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst b/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst index 2abb190e316..03daf724ef6 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst @@ -66,16 +66,7 @@ DESCRIPTION ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_get` :ref:`MPI_Info_get_nthkey` :ref:`MPI_Info_get_valuelen` diff --git a/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst b/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst index 85b1827c39f..dfd0e3b8f75 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst @@ -71,16 +71,7 @@ not modified with :ref:`MPI_Info_set` or :ref:`MPI_Info_delete`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_get` :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_valuelen` diff --git a/docs/man-openmpi/man3/MPI_Info_get_string.3.rst b/docs/man-openmpi/man3/MPI_Info_get_string.3.rst index ad7e6c04d90..5ed3f7e9435 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_string.3.rst @@ -87,16 +87,7 @@ If *key* is larger than MPI_MAX_INFO_KEY, the call is erroneous. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` diff --git a/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst b/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst index 9eb833414eb..c4b15c56452 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst @@ -78,16 +78,7 @@ If *key* is larger than MPI_MAX_INFO_KEY, the call is erroneous. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_get` :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_nthkey` diff --git a/docs/man-openmpi/man3/MPI_Info_set.3.rst b/docs/man-openmpi/man3/MPI_Info_set.3.rst index 87972690fd6..7fd95136472 100644 --- a/docs/man-openmpi/man3/MPI_Info_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_set.3.rst @@ -74,16 +74,7 @@ or MPI_ERR_INFO_VALUE is raised, respectively. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Init.3.rst b/docs/man-openmpi/man3/MPI_Init.3.rst index 42ade5d2d7f..75d8df5e86f 100644 --- a/docs/man-openmpi/man3/MPI_Init.3.rst +++ b/docs/man-openmpi/man3/MPI_Init.3.rst @@ -92,18 +92,7 @@ input, or writing to standard output. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init_thread` :ref:`MPI_Initialized` :ref:`MPI_Finalize` :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Init_thread.3.rst b/docs/man-openmpi/man3/MPI_Init_thread.3.rst index 7b2f1b0f607..f5461326c20 100644 --- a/docs/man-openmpi/man3/MPI_Init_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Init_thread.3.rst @@ -147,16 +147,7 @@ as compared to when using MPI_THREAD_SINGLE, for example. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` :ref:`MPI_Initialized` :ref:`MPI_Finalize` :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Initialized.3.rst b/docs/man-openmpi/man3/MPI_Initialized.3.rst index af5c2c3a6cf..e12b746bf4e 100644 --- a/docs/man-openmpi/man3/MPI_Initialized.3.rst +++ b/docs/man-openmpi/man3/MPI_Initialized.3.rst @@ -62,16 +62,7 @@ initialized and after MPI has been finalized (:ref:`MPI_Finalized` is another). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` :ref:`MPI_Init_thread` :ref:`MPI_Finalize` :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst index 638ffcfd9f9..59af03b42c6 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst @@ -102,16 +102,7 @@ the groups are not disjoint. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Intercomm_merge` :ref:`MPI_Comm_free` :ref:`MPI_Comm_remote_group` diff --git a/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst index 7b5d8dab269..d1414613a7e 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst @@ -99,14 +99,6 @@ shall have a value of at least 63. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`; -the predefined error handler MPI_ERRORS_RETURN may be used to cause -error values to be returned. Note that MPI does not guarantee that an -MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_from_group` diff --git a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst index 0fd3ccb0ea1..813bbdc6ac1 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst @@ -76,16 +76,7 @@ blocking and collective within the union of the two groups. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_free` diff --git a/docs/man-openmpi/man3/MPI_Iprobe.3.rst b/docs/man-openmpi/man3/MPI_Iprobe.3.rst index 0e2994e672b..bb672240943 100644 --- a/docs/man-openmpi/man3/MPI_Iprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Iprobe.3.rst @@ -116,16 +116,7 @@ that actually returns true for the same message for both threads. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Probe` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Irecv.3.rst b/docs/man-openmpi/man3/MPI_Irecv.3.rst index 5f6c10f9945..0ae2e2bf738 100644 --- a/docs/man-openmpi/man3/MPI_Irecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Irecv.3.rst @@ -87,16 +87,7 @@ this function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Recv` :ref:`MPI_Probe` :ref:`MPI_Test` :ref:`MPI_Testany` :ref:`MPI_Wait` :ref:`MPI_Waitany` diff --git a/docs/man-openmpi/man3/MPI_Irsend.3.rst b/docs/man-openmpi/man3/MPI_Irsend.3.rst index ab2d3575068..ecfe69d4113 100644 --- a/docs/man-openmpi/man3/MPI_Irsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Irsend.3.rst @@ -82,16 +82,7 @@ completes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Rsend` diff --git a/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst b/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst index 582b3714db9..033fb44409d 100644 --- a/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst +++ b/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst @@ -62,18 +62,7 @@ MPI_Init_thread). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` :ref:`MPI_Init_thread` diff --git a/docs/man-openmpi/man3/MPI_Isend.3.rst b/docs/man-openmpi/man3/MPI_Isend.3.rst index 23b45bb9796..7d9d94143bf 100644 --- a/docs/man-openmpi/man3/MPI_Isend.3.rst +++ b/docs/man-openmpi/man3/MPI_Isend.3.rst @@ -86,16 +86,7 @@ this function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Send` :ref:`MPI_Wait` :ref:`MPI_Waitany` :ref:`MPI_Test` :ref:`MPI_Testany` diff --git a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst index 04c1d556ce7..1f4c3482bcd 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst @@ -108,16 +108,7 @@ request returned by this function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Isendrecv_replace` :ref:`MPI_Sendrecv` :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst index aacddba40dd..65d5038fb45 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst @@ -105,16 +105,7 @@ request returned by this function. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Isendrecv` :ref:`MPI_Sendrecv` :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Issend.3.rst b/docs/man-openmpi/man3/MPI_Issend.3.rst index a141fea8206..778fc0976bf 100644 --- a/docs/man-openmpi/man3/MPI_Issend.3.rst +++ b/docs/man-openmpi/man3/MPI_Issend.3.rst @@ -84,16 +84,7 @@ completes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Ssend` diff --git a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst index cfb4a8e629f..991b62fe5c3 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst @@ -153,16 +153,7 @@ of key values. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Keyval_free` :ref:`MPI_Comm_create_keyval` diff --git a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst index 28978a403e8..0421cc80f15 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst @@ -67,16 +67,7 @@ Key values are global (they can be used with any and all communicators). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Keyval_create` :ref:`MPI_Comm_free_keyval` diff --git a/docs/man-openmpi/man3/MPI_Lookup_name.3.rst b/docs/man-openmpi/man3/MPI_Lookup_name.3.rst index 9780f882736..946ac4bcb9f 100644 --- a/docs/man-openmpi/man3/MPI_Lookup_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Lookup_name.3.rst @@ -121,18 +121,7 @@ For a more detailed description of scoping rules, please see the ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Publish_name` :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Mprobe.3.rst b/docs/man-openmpi/man3/MPI_Mprobe.3.rst index 7cd08dbc9c6..e1137fd7fc8 100644 --- a/docs/man-openmpi/man3/MPI_Mprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Mprobe.3.rst @@ -86,16 +86,7 @@ message can then be received by passing the *message* handle to the ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Mrecv` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Mrecv.3.rst b/docs/man-openmpi/man3/MPI_Mrecv.3.rst index b82157836a4..44121334580 100644 --- a/docs/man-openmpi/man3/MPI_Mrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Mrecv.3.rst @@ -79,16 +79,7 @@ from MPI_PROC_NULL was issued. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Mprobe` :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst index 33411bcce9e..987421b1baf 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst @@ -165,16 +165,7 @@ operation. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Neighbor_allgatherv` :ref:`MPI_Cart_create` MPI_Garph_create diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst index d0e59b8329a..a0b36378150 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst @@ -174,16 +174,7 @@ operation. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Neighbor_allgather` :ref:`MPI_Cart_create` :ref:`MPI_Graph_create` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst index 8a277634292..b3e7533f2b8 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst @@ -208,16 +208,7 @@ allow the exchange of data with different datatypes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Neighbor_alltoallv` :ref:`MPI_Neighbor_alltoallw` :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst index 5c3f4ee40ad..8ad37899f9b 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst @@ -224,16 +224,7 @@ The offsets of *sdispls* and *rdispls* are measured in units of ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Neighbor_alltoall` :ref:`MPI_Neighbor_alltoallw` :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst index 26fd3b5f03e..72d87a53214 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst @@ -211,16 +211,7 @@ units of *sendtype* and *recvtype*, respectively. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Neighbor_alltoall` :ref:`MPI_Neighbor_alltoallv` :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst index 7114de3e78c..b5b4be60bc1 100644 --- a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst @@ -65,16 +65,7 @@ Reduction operations can be queried for their commutativity. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Op_create` diff --git a/docs/man-openmpi/man3/MPI_Op_create.3.rst b/docs/man-openmpi/man3/MPI_Op_create.3.rst index d211d8dbed7..299a5e39b27 100644 --- a/docs/man-openmpi/man3/MPI_Op_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_create.3.rst @@ -214,16 +214,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Reduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Allreduce` :ref:`MPI_Scan` :ref:`MPI_Op_free` diff --git a/docs/man-openmpi/man3/MPI_Op_free.3.rst b/docs/man-openmpi/man3/MPI_Op_free.3.rst index 717267d3389..1ec6a2999c5 100644 --- a/docs/man-openmpi/man3/MPI_Op_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_free.3.rst @@ -63,16 +63,7 @@ to MPI_OP_NULL. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Op_create` :ref:`MPI_Reduce` :ref:`MPI_Allreduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` diff --git a/docs/man-openmpi/man3/MPI_Open_port.3.rst b/docs/man-openmpi/man3/MPI_Open_port.3.rst index 725741756ad..fbcd32b61de 100644 --- a/docs/man-openmpi/man3/MPI_Open_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Open_port.3.rst @@ -79,16 +79,7 @@ None. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_accept` :ref:`MPI_Comm_connect` diff --git a/docs/man-openmpi/man3/MPI_Pack.3.rst b/docs/man-openmpi/man3/MPI_Pack.3.rst index fe3f901401a..748d289f57b 100644 --- a/docs/man-openmpi/man3/MPI_Pack.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack.3.rst @@ -116,16 +116,7 @@ subsequently used for sending the packed message. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Unpack` :ref:`MPI_Pack_size` diff --git a/docs/man-openmpi/man3/MPI_Pack_external.3.rst b/docs/man-openmpi/man3/MPI_Pack_external.3.rst index 4387e675ff1..813a1baef99 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external.3.rst @@ -176,18 +176,7 @@ of related unpack calls. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external_size` :ref:`MPI_Send` :ref:`MPI_Unpack_external` sscanf(3C) diff --git a/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst b/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst index 2420e7940a3..4aca72a9726 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst @@ -90,18 +90,7 @@ for future extensibility. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external` :ref:`MPI_Unpack_external` diff --git a/docs/man-openmpi/man3/MPI_Pack_size.3.rst b/docs/man-openmpi/man3/MPI_Pack_size.3.rst index e30a103f6a4..94d091a8ed6 100644 --- a/docs/man-openmpi/man3/MPI_Pack_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_size.3.rst @@ -79,16 +79,7 @@ take more space). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack` :ref:`MPI_Unpack` diff --git a/docs/man-openmpi/man3/MPI_Parrived.3.rst b/docs/man-openmpi/man3/MPI_Parrived.3.rst index bf2f60c42a2..acf83ce95f4 100644 --- a/docs/man-openmpi/man3/MPI_Parrived.3.rst +++ b/docs/man-openmpi/man3/MPI_Parrived.3.rst @@ -61,16 +61,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pready_list` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready.3.rst b/docs/man-openmpi/man3/MPI_Pready.3.rst index 6c44b2e6f12..4c31824cc1c 100644 --- a/docs/man-openmpi/man3/MPI_Pready.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready.3.rst @@ -59,16 +59,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pready_list` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready_list.3.rst b/docs/man-openmpi/man3/MPI_Pready_list.3.rst index 8c943335c06..32ccf5ff6bf 100644 --- a/docs/man-openmpi/man3/MPI_Pready_list.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_list.3.rst @@ -61,16 +61,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pready` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready_range.3.rst b/docs/man-openmpi/man3/MPI_Pready_range.3.rst index 3e91b7786af..bd9438063bb 100644 --- a/docs/man-openmpi/man3/MPI_Pready_range.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_range.3.rst @@ -60,16 +60,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pready` :ref:`MPI_Pready_list` :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Precv_init.3.rst b/docs/man-openmpi/man3/MPI_Precv_init.3.rst index fc8f282f77b..7fa3642407a 100644 --- a/docs/man-openmpi/man3/MPI_Precv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Precv_init.3.rst @@ -69,16 +69,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst NOTE ---- diff --git a/docs/man-openmpi/man3/MPI_Probe.3.rst b/docs/man-openmpi/man3/MPI_Probe.3.rst index da6754123a7..844dedf9d5d 100644 --- a/docs/man-openmpi/man3/MPI_Probe.3.rst +++ b/docs/man-openmpi/man3/MPI_Probe.3.rst @@ -141,16 +141,7 @@ that is distinct from the message probed by the preceding call to ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Iprobe` :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Psend_init.3.rst b/docs/man-openmpi/man3/MPI_Psend_init.3.rst index 2ba8fb73be4..298a93da7c2 100644 --- a/docs/man-openmpi/man3/MPI_Psend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Psend_init.3.rst @@ -69,16 +69,7 @@ OUTPUT PARAMETERS ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst NOTE ---- diff --git a/docs/man-openmpi/man3/MPI_Publish_name.3.rst b/docs/man-openmpi/man3/MPI_Publish_name.3.rst index 224b8ab2319..4fb9f77cb00 100644 --- a/docs/man-openmpi/man3/MPI_Publish_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Publish_name.3.rst @@ -154,18 +154,7 @@ communication with it. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Lookup_name` :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Put.3.rst b/docs/man-openmpi/man3/MPI_Put.3.rst index e7b8a8c3398..271f3b099d8 100644 --- a/docs/man-openmpi/man3/MPI_Put.3.rst +++ b/docs/man-openmpi/man3/MPI_Put.3.rst @@ -181,16 +181,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Get` :ref:`MPI_Rget` :ref:`MPI_Accumulate` :ref:`MPI_Win_flush` :ref:`MPI_Win_flush_all` diff --git a/docs/man-openmpi/man3/MPI_Query_thread.3.rst b/docs/man-openmpi/man3/MPI_Query_thread.3.rst index b075f5f104c..5a1b18d2a29 100644 --- a/docs/man-openmpi/man3/MPI_Query_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Query_thread.3.rst @@ -86,18 +86,7 @@ is MPI_THREAD_MULTIPLE. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Init` :ref:`MPI_Init_thread` diff --git a/docs/man-openmpi/man3/MPI_Recv.3.rst b/docs/man-openmpi/man3/MPI_Recv.3.rst index 17745e1bb34..382c7d993a2 100644 --- a/docs/man-openmpi/man3/MPI_Recv.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv.3.rst @@ -144,16 +144,7 @@ special value for the *status* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Irecv` :ref:`MPI_Probe` diff --git a/docs/man-openmpi/man3/MPI_Recv_init.3.rst b/docs/man-openmpi/man3/MPI_Recv_init.3.rst index cd0dc29b4d9..ac423a8a152 100644 --- a/docs/man-openmpi/man3/MPI_Recv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv_init.3.rst @@ -86,16 +86,7 @@ initiated by the function :ref:`MPI_Start` or :ref:`MPI_Startall`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` MPI_Sssend_init :ref:`MPI_Start` diff --git a/docs/man-openmpi/man3/MPI_Reduce.3.rst b/docs/man-openmpi/man3/MPI_Reduce.3.rst index 5d66aab0b75..f049398b571 100644 --- a/docs/man-openmpi/man3/MPI_Reduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce.3.rst @@ -550,16 +550,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Allreduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` :ref:`MPI_Op_create` :ref:`MPI_Op_free` diff --git a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst index 6b0de5f5316..c3f9a28ed8b 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst @@ -318,16 +318,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Allreduce` :ref:`MPI_Reduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` :ref:`MPI_Op_create` diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst index f5c83693e81..b33b0db933b 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst @@ -163,12 +163,4 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst index 03460c04e90..6157c54b29b 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst @@ -166,16 +166,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Reduce_scatter` diff --git a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst index bac151657e1..52fdfee1cd3 100644 --- a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst +++ b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst @@ -118,12 +118,4 @@ Error classes are found in mpi.h (for C) and mpif.h (for Fortran). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. For MPI I/O function errors, the default error handler is set to -MPI_ERRORS_RETURN. The error handler may be changed with -:ref:`MPI_File_set_errhandler`; the predefined error handler -MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI -does not guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Request_free.3.rst b/docs/man-openmpi/man3/MPI_Request_free.3.rst index cbf52795a56..28bb691f98c 100644 --- a/docs/man-openmpi/man3/MPI_Request_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_free.3.rst @@ -118,16 +118,7 @@ can not use the request in a wait or test routine (e.g., :ref:`MPI_Wait` ). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include ../ERRORS.rst .. seealso:: :ref:`MPI_Isend` :ref:`MPI_Irecv` :ref:`MPI_Issend` :ref:`MPI_Ibsend` :ref:`MPI_Irsend` :ref:`MPI_Recv_init` diff --git a/docs/man-openmpi/man3/MPI_Request_get_status.3.rst b/docs/man-openmpi/man3/MPI_Request_get_status.3.rst index cf8fc602d3d..039f70b6a9e 100644 --- a/docs/man-openmpi/man3/MPI_Request_get_status.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_get_status.3.rst @@ -75,12 +75,4 @@ special value for the *status* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Rsend.3.rst b/docs/man-openmpi/man3/MPI_Rsend.3.rst index 1835dec1fb6..84ea615c5ab 100644 --- a/docs/man-openmpi/man3/MPI_Rsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend.3.rst @@ -74,12 +74,4 @@ the ready send is called. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst index e39ffba7833..fb5c94bb9d3 100644 --- a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst @@ -79,16 +79,7 @@ initiated by the function :ref:`MPI_Start`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Send_init` MPI_Sssend_init :ref:`MPI_Recv_init` :ref:`MPI_Start` diff --git a/docs/man-openmpi/man3/MPI_Scan.3.rst b/docs/man-openmpi/man3/MPI_Scan.3.rst index 63089b890d2..49dd8f31fbb 100644 --- a/docs/man-openmpi/man3/MPI_Scan.3.rst +++ b/docs/man-openmpi/man3/MPI_Scan.3.rst @@ -238,18 +238,7 @@ collective routines return the same error value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Exscan` :ref:`MPI_Op_create` :ref:`MPI_Reduce` diff --git a/docs/man-openmpi/man3/MPI_Scatter.3.rst b/docs/man-openmpi/man3/MPI_Scatter.3.rst index 849acfa09b3..cda14d6166e 100644 --- a/docs/man-openmpi/man3/MPI_Scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatter.3.rst @@ -208,16 +208,7 @@ processes in the second group. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Scatterv` :ref:`MPI_Gather` :ref:`MPI_Gatherv` diff --git a/docs/man-openmpi/man3/MPI_Scatterv.3.rst b/docs/man-openmpi/man3/MPI_Scatterv.3.rst index 6b1cab65469..cee4ca49ae3 100644 --- a/docs/man-openmpi/man3/MPI_Scatterv.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatterv.3.rst @@ -253,16 +253,7 @@ processes in the second group. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Gather` :ref:`MPI_Gatherv` :ref:`MPI_Scatter` diff --git a/docs/man-openmpi/man3/MPI_Send.3.rst b/docs/man-openmpi/man3/MPI_Send.3.rst index 37a5bab56c5..ce58d41f1e3 100644 --- a/docs/man-openmpi/man3/MPI_Send.3.rst +++ b/docs/man-openmpi/man3/MPI_Send.3.rst @@ -80,16 +80,7 @@ refer to the MPI-1 Standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Isend` :ref:`MPI_Bsend` :ref:`MPI_Recv` diff --git a/docs/man-openmpi/man3/MPI_Send_init.3.rst b/docs/man-openmpi/man3/MPI_Send_init.3.rst index 32f5b60fa2a..16952c8fca9 100644 --- a/docs/man-openmpi/man3/MPI_Send_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Send_init.3.rst @@ -80,16 +80,7 @@ initiated by the function :ref:`MPI_Start` or :ref:`MPI_Startall`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Ssend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Recv_init` :ref:`MPI_Start` diff --git a/docs/man-openmpi/man3/MPI_Sendrecv.3.rst b/docs/man-openmpi/man3/MPI_Sendrecv.3.rst index 6ce37bd15da..cf34e2b167f 100644 --- a/docs/man-openmpi/man3/MPI_Sendrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Sendrecv.3.rst @@ -114,16 +114,7 @@ special value for the *status* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst b/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst index a6eb215de60..6ba0c15c398 100644 --- a/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst +++ b/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst @@ -110,16 +110,7 @@ one to execute the receive, followed by a join of these two threads. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Sendrecv` diff --git a/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst index d718f61f308..aaf496954fc 100644 --- a/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst @@ -72,9 +72,6 @@ processes in session if the default error handler has not been changed. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. See the MPI -man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_create_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst index 877777e9244..9065a3a24a6 100644 --- a/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst @@ -82,12 +82,4 @@ Fortran, the user routine should be of this form: Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the ``function`` and Fortran routines in the last argument. Before -the error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O -``function`` errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. -Note that MPI does not guarantee that an MPI program can continue past -an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst index 5579742e031..d71a19a35e5 100644 --- a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst @@ -81,15 +81,6 @@ disconnected (with MPI_Comm_disconnect). Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst index 7a301c85f18..83ec012a44e 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst @@ -67,14 +67,4 @@ with a session. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Session_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Session_get_info.3.rst b/docs/man-openmpi/man3/MPI_Session_get_info.3.rst index 210b95b9cf4..fb8f874d863 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_info.3.rst @@ -74,15 +74,6 @@ The user is responsible for freeing info_used via :ref:`MPI_Info_free`. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst b/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst index d805d1439f6..5af3e0a155e 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst @@ -88,15 +88,6 @@ value of at least 63. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst b/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst index 9414bd44a87..820e4c21d0c 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst @@ -81,15 +81,6 @@ group and attempting collective communication may raise an error. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst b/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst index 767fcf97454..ea68f6bc787 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst @@ -75,15 +75,6 @@ The user is responsible for freeing the returned info object via Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with -MPI_Session_set_errhandler; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_init` diff --git a/docs/man-openmpi/man3/MPI_Session_init.3.rst b/docs/man-openmpi/man3/MPI_Session_init.3.rst index 3d66fae8bd5..9c8ae87d1a5 100644 --- a/docs/man-openmpi/man3/MPI_Session_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_init.3.rst @@ -77,13 +77,6 @@ event that the Session instantiation call encounters an error. Errors ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. Before the -error value is returned, the current MPI error handler is called. By -default, this error handler aborts the MPI job, except for I/O function -errors. The predefined error handler MPI_ERRORS_RETURN may be used to -cause error values to be returned. Note that MPI does not guarantee that -an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Session_get_num_psets` MPI_Session_group_from_pset diff --git a/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst index 3244e581197..be3101c1be1 100644 --- a/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst @@ -68,12 +68,4 @@ handler created by a call to :ref:`MPI_Session_create_errhandler`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Session_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Sizeof.3.rst b/docs/man-openmpi/man3/MPI_Sizeof.3.rst index 0ad4b99a146..02131db0c08 100644 --- a/docs/man-openmpi/man3/MPI_Sizeof.3.rst +++ b/docs/man-openmpi/man3/MPI_Sizeof.3.rst @@ -65,14 +65,4 @@ This function is not available in C because it is not necessary. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Ssend.3.rst b/docs/man-openmpi/man3/MPI_Ssend.3.rst index e6b0d41b3ac..6fc37457506 100644 --- a/docs/man-openmpi/man3/MPI_Ssend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend.3.rst @@ -73,12 +73,4 @@ Standard for more detailed information about such sends. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst index 6e610fa0006..def77911dd9 100644 --- a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst @@ -79,16 +79,7 @@ initiated by the function :ref:`MPI_Start`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Send_init` :ref:`MPI_Rsend_init` :ref:`MPI_Recv_init` :ref:`MPI_Start` diff --git a/docs/man-openmpi/man3/MPI_Start.3.rst b/docs/man-openmpi/man3/MPI_Start.3.rst index 64a98d5e9d6..66da3402594 100644 --- a/docs/man-openmpi/man3/MPI_Start.3.rst +++ b/docs/man-openmpi/man3/MPI_Start.3.rst @@ -83,16 +83,7 @@ call to :ref:`MPI_Ibsend`; and so on. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` MPI_Sssend_init diff --git a/docs/man-openmpi/man3/MPI_Startall.3.rst b/docs/man-openmpi/man3/MPI_Startall.3.rst index f53058f324f..b26a70992b1 100644 --- a/docs/man-openmpi/man3/MPI_Startall.3.rst +++ b/docs/man-openmpi/man3/MPI_Startall.3.rst @@ -102,16 +102,7 @@ receive operation and, likewise, a receive operation initiated with ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` :ref:`MPI_Ssend_init` :ref:`MPI_Recv_init` diff --git a/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst b/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst index 805d107f223..b2613adfcbb 100644 --- a/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst @@ -85,12 +85,4 @@ unpredictable results and is strongly discouraged. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst b/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst index 0772ae76815..babe8ac1b5b 100644 --- a/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst @@ -102,16 +102,7 @@ unpredictable results and is strongly discouraged.* ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst FORTRAN 77 NOTES ---------------- diff --git a/docs/man-openmpi/man3/MPI_Test.3.rst b/docs/man-openmpi/man3/MPI_Test.3.rst index 21e3a970b14..ab5e3fe2f28 100644 --- a/docs/man-openmpi/man3/MPI_Test.3.rst +++ b/docs/man-openmpi/man3/MPI_Test.3.rst @@ -99,17 +99,7 @@ event-driven thread scheduler can be emulated with periodic calls to ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`, :ref:`MPI_File_set_errhandler`, or -:ref:`MPI_Win_set_errhandler` (depending on the type of MPI handle that -generated the request); the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst Note that per MPI-1 section 3.2.5, MPI errors on requests passed to :ref:`MPI_TEST` do not set the status.MPI_ERROR field in the returned status. diff --git a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst index e620a289309..e5dae86872d 100644 --- a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst @@ -77,12 +77,4 @@ exceptionally. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Testall.3.rst b/docs/man-openmpi/man3/MPI_Testall.3.rst index b6f8c5d9989..e844a5789d7 100644 --- a/docs/man-openmpi/man3/MPI_Testall.3.rst +++ b/docs/man-openmpi/man3/MPI_Testall.3.rst @@ -99,6 +99,8 @@ modified. ERRORS ------ +.. include:: ./ERRORS.rst + For each invocation of :ref:`MPI_Testall`, if one or more requests generate an MPI error, only the *first* MPI request that caused an error will be passed to its corresponding error handler. No other error handlers will @@ -107,14 +109,6 @@ requests that generate an error will have a relevant error code set in the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was used). -The default error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`, -:ref:`MPI_File_set_errhandler`, or :ref:`MPI_Win_set_errhandler` (depending on the -type of MPI handle that generated the MPI request); the predefined error -handler MPI_ERRORS_RETURN may be used to cause error values to be -returned. Note that MPI does not guarantee that an MPI program can -continue past an error. - If the invoked error handler allows :ref:`MPI_Testall` to return to the caller, the value MPI_ERR_IN_STATUS will be returned in the C and Fortran bindings. diff --git a/docs/man-openmpi/man3/MPI_Testany.3.rst b/docs/man-openmpi/man3/MPI_Testany.3.rst index 4ccc1ad34a6..b038566a64e 100644 --- a/docs/man-openmpi/man3/MPI_Testany.3.rst +++ b/docs/man-openmpi/man3/MPI_Testany.3.rst @@ -99,17 +99,7 @@ special value for the *status* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`, :ref:`MPI_File_set_errhandler`, or -:ref:`MPI_Win_set_errhandler` (depending on the type of MPI handle that -generated the request); the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst Note that per MPI-1 section 3.2.5, MPI errors on requests passed to :ref:`MPI_TESTANY` do not set the status.MPI_ERROR field in the returned @@ -118,7 +108,6 @@ be passed back to the caller through the return value of :ref:`MPI_TESTANY` if the back-end error handler returns it. The pre-defined MPI error handler MPI_ERRORS_RETURN exhibits this behavior, for example. - .. seealso:: :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` diff --git a/docs/man-openmpi/man3/MPI_Testsome.3.rst b/docs/man-openmpi/man3/MPI_Testsome.3.rst index 80c7109a02a..a523d7fd0c4 100644 --- a/docs/man-openmpi/man3/MPI_Testsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Testsome.3.rst @@ -122,6 +122,8 @@ another client always sneak in first. ERRORS ------ +.. include:: ./ERRORS.rst + For each invocation of :ref:`MPI_Testsome`, if one or more requests generate an MPI error, only the *first* MPI request that caused an error will be passed to its corresponding error handler. No other error handlers will @@ -130,19 +132,10 @@ requests that generate an error will have a relevant error code set in the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was used). -The default error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`, -:ref:`MPI_File_set_errhandler`, or :ref:`MPI_Win_set_errhandler` (depending on the -type of MPI handle that generated the MPI request); the predefined error -handler MPI_ERRORS_RETURN may be used to cause error values to be -returned. Note that MPI does not guarantee that an MPI program can -continue past an error. - If the invoked error handler allows :ref:`MPI_Testsome` to return to the caller, the value MPI_ERR_IN_STATUS will be returned in the C and Fortran bindings. - .. seealso:: :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` :ref:`MPI_Testany` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` diff --git a/docs/man-openmpi/man3/MPI_Topo_test.3.rst b/docs/man-openmpi/man3/MPI_Topo_test.3.rst index d809cdc1bea..41de9be79bd 100644 --- a/docs/man-openmpi/man3/MPI_Topo_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Topo_test.3.rst @@ -77,16 +77,7 @@ The output value *top_type* is one of the following: ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Graph_create` :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Type_commit.3.rst b/docs/man-openmpi/man3/MPI_Type_commit.3.rst index 7dac78a09b8..8ce2e3732b7 100644 --- a/docs/man-openmpi/man3/MPI_Type_commit.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_commit.3.rst @@ -80,12 +80,4 @@ equivalent to a no-op. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst index 11f5b43ae88..23d9168e6c8 100644 --- a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst @@ -103,12 +103,4 @@ MPI-1 Standard. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst b/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst index 72db1f1d3a8..7d2d6fa8682 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst @@ -161,12 +161,4 @@ provided in MPI-1. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst index 302d3be4c5e..d1f8d46da3f 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst @@ -124,18 +124,7 @@ the only way to obtain a matching MPI datatype is to use the functions ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst index eb6dd369193..cf43121e85e 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst @@ -117,18 +117,7 @@ to obtain a matching MPI datatype is to use the functions :ref:`MPI_Sizeof` and ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst index 3ac51726b2d..881131e60f3 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst @@ -123,18 +123,7 @@ the only way to obtain a matching MPI datatype is to use the functions ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` diff --git a/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst index 57aa324eb1a..71650bbd093 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst @@ -94,16 +94,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_hvector` :ref:`MPI_Type_vector` diff --git a/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst b/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst index 883716a1191..b964c2924e5 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst @@ -94,16 +94,7 @@ while :ref:`MPI_Type_create_hindexed_block` takes displacements in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_indexed` diff --git a/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst index 311209a065f..b4e22b3822b 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst @@ -136,16 +136,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_free_keyval` diff --git a/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst b/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst index e34a115d694..91f67332d13 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst @@ -101,16 +101,7 @@ MPI-1 functions :ref:`MPI_Type_extent` and :ref:`MPI_Type_lb`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst index 208809839f7..110c813c852 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst @@ -95,16 +95,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_struct` :ref:`MPI_Type_create_hindexed` diff --git a/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst b/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst index cebd63296f2..8f1aa34531f 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst @@ -152,13 +152,4 @@ then the entry in array of starts for that dimension is *n*-1. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler(3) `; the -predefined error handler MPI_ERRORS_RETURN may be used to cause error -values to be returned. Note that MPI does not guarantee that an MPI -program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst index 92478384ea0..66beb473d9e 100644 --- a/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst @@ -80,12 +80,4 @@ being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_dup.3.rst b/docs/man-openmpi/man3/MPI_Type_dup.3.rst index 90943750d38..68e9444bc7e 100644 --- a/docs/man-openmpi/man3/MPI_Type_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_dup.3.rst @@ -83,16 +83,7 @@ callback is being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_keyval` diff --git a/docs/man-openmpi/man3/MPI_Type_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_extent.3.rst index 9bcd35f6c9b..d7595f60da6 100644 --- a/docs/man-openmpi/man3/MPI_Type_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_extent.3.rst @@ -89,16 +89,7 @@ extent(Typemap) to the next multiple of max(i) k(i). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_free.3.rst b/docs/man-openmpi/man3/MPI_Type_free.3.rst index 7b61951649b..82ead6c964b 100644 --- a/docs/man-openmpi/man3/MPI_Type_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free.3.rst @@ -69,12 +69,4 @@ arguments to derived datatype constructors are passed by value. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst index 42d3cabe1cf..358a6804898 100644 --- a/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst @@ -60,16 +60,7 @@ DESCRIPTION ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_keyval` diff --git a/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst index 82c0fc3d858..5e9b172d564 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst @@ -87,16 +87,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_set_attr` diff --git a/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst b/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst index b3cc50bde6b..dab60eee5ed 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst @@ -139,16 +139,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_envelope` diff --git a/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst b/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst index f2fc6274efd..f983bcbd81b 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst @@ -115,16 +115,7 @@ obtained from the call :ref:`MPI_Type_get_contents`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_contents` diff --git a/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst index 4de4e9ca4dd..8536e0252e6 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst @@ -115,12 +115,4 @@ mpif.h and give the length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_get_name.3.rst b/docs/man-openmpi/man3/MPI_Type_get_name.3.rst index a2b5e0df194..e8983dfdf2d 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_name.3.rst @@ -69,16 +69,7 @@ MPI data type. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_set_name` diff --git a/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst index a5782a04742..77e6158c420 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst @@ -119,12 +119,4 @@ mpif.h and give the length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst index f9f2c5aaf09..d66d8ffabdd 100644 --- a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst @@ -86,16 +86,7 @@ array_of_displacements argument. The newly created datatype has ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_hindexed` :ref:`MPI_Type_indexed` diff --git a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst index a4ca604223b..97b4b94609f 100644 --- a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst @@ -87,16 +87,7 @@ has a type map with count \* bl \* n entries: ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_hvector` :ref:`MPI_Type_vector` diff --git a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst index 1604d186022..6f01dcf12db 100644 --- a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst @@ -154,16 +154,7 @@ specified in bytes, rather than in multiples of the *oldtype* extent. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_hindexed` diff --git a/docs/man-openmpi/man3/MPI_Type_lb.3.rst b/docs/man-openmpi/man3/MPI_Type_lb.3.rst index 22fd099638c..44dd1c20533 100644 --- a/docs/man-openmpi/man3/MPI_Type_lb.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_lb.3.rst @@ -96,16 +96,7 @@ extent(Typemap) to the next multiple of max(i) k(i). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_match_size.3.rst b/docs/man-openmpi/man3/MPI_Type_match_size.3.rst index 3c399ba0a7f..719beec6afd 100644 --- a/docs/man-openmpi/man3/MPI_Type_match_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_match_size.3.rst @@ -80,18 +80,7 @@ It is erroneous to specify a size not supported by the compiler. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Sizeof` :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst index 53093184021..b5d36bee46b 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst @@ -87,16 +87,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_attr` diff --git a/docs/man-openmpi/man3/MPI_Type_set_name.3.rst b/docs/man-openmpi/man3/MPI_Type_set_name.3.rst index 3fb01a6f149..109b4568449 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_name.3.rst @@ -69,16 +69,7 @@ type. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_name` diff --git a/docs/man-openmpi/man3/MPI_Type_size.3.rst b/docs/man-openmpi/man3/MPI_Type_size.3.rst index b54fb8452c5..f5fdfea4945 100644 --- a/docs/man-openmpi/man3/MPI_Type_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_size.3.rst @@ -80,16 +80,7 @@ hold the output value), it is set to MPI_UNDEFINED. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst FORTRAN 77 NOTES ---------------- diff --git a/docs/man-openmpi/man3/MPI_Type_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_struct.3.rst index 9420ff45fcf..8877bf0fa81 100644 --- a/docs/man-openmpi/man3/MPI_Type_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_struct.3.rst @@ -128,16 +128,7 @@ be used for the structure foo: ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_struct` :ref:`MPI_Type_create_hindexed` diff --git a/docs/man-openmpi/man3/MPI_Type_ub.3.rst b/docs/man-openmpi/man3/MPI_Type_ub.3.rst index 5c20cba388d..bc4d8a873e9 100644 --- a/docs/man-openmpi/man3/MPI_Type_ub.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_ub.3.rst @@ -101,16 +101,7 @@ extent(Typemap) to the next multiple of max(i) k(i). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_vector.3.rst b/docs/man-openmpi/man3/MPI_Type_vector.3.rst index b7eb80e160b..1819f480ab9 100644 --- a/docs/man-openmpi/man3/MPI_Type_vector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_vector.3.rst @@ -128,16 +128,7 @@ to MPI_Type_vector(1, count, n, oldtype, newtype), n arbitrary. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Type_create_hvector` :ref:`MPI_Type_hvector` diff --git a/docs/man-openmpi/man3/MPI_Unpack.3.rst b/docs/man-openmpi/man3/MPI_Unpack.3.rst index 3ba1d9df4eb..7ee2ae0b069 100644 --- a/docs/man-openmpi/man3/MPI_Unpack.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack.3.rst @@ -149,16 +149,7 @@ a unit, by a sequence of related unpack calls. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack` :ref:`MPI_Pack_size` diff --git a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst index 6af42892483..0b1ce029049 100644 --- a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst @@ -154,18 +154,7 @@ of related unpack calls. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Pack_external` :ref:`MPI_Pack_external_size` :ref:`MPI_Recv` sscanf(3C) diff --git a/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst b/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst index 5b1b52d5233..e24caf41ea8 100644 --- a/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst @@ -117,18 +117,7 @@ For a more detailed description of scoping rules, please see the ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Publish_name` :ref:`MPI_Lookup_name` :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Wait.3.rst b/docs/man-openmpi/man3/MPI_Wait.3.rst index 98b75c5950e..d4bf08807a1 100644 --- a/docs/man-openmpi/man3/MPI_Wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Wait.3.rst @@ -111,17 +111,7 @@ Example: Simple usage of nonblocking operations and :ref:`MPI_Wait`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`, :ref:`MPI_File_set_errhandler`, or -:ref:`MPI_Win_set_errhandler` (depending on the type of MPI handle that -generated the request); the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst Note that per MPI-1 section 3.2.5, MPI errors on requests passed to :ref:`MPI_WAIT` do not set the status.MPI_ERROR field in the returned status. diff --git a/docs/man-openmpi/man3/MPI_Waitall.3.rst b/docs/man-openmpi/man3/MPI_Waitall.3.rst index e04a5eea6b2..360d1ea1a6e 100644 --- a/docs/man-openmpi/man3/MPI_Waitall.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitall.3.rst @@ -99,6 +99,8 @@ MPI_STATUSES_IGNORE can be used as a special value for the ERRORS ------ +.. include:: ./ERRORS.rst + For each invocation of :ref:`MPI_Waitall`, if one or more requests generate an MPI error, only the *first* MPI request that caused an error will be passed to its corresponding error handler. No other error handlers will @@ -107,14 +109,6 @@ requests that generate an error will have a relevant error code set in the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was used). -The default error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`, -:ref:`MPI_File_set_errhandler`, or :ref:`MPI_Win_set_errhandler` (depending on the -type of MPI handle that generated the MPI request); the predefined error -handler MPI_ERRORS_RETURN may be used to cause error values to be -returned. Note that MPI does not guarantee that an MPI program can -continue past an error. - If the invoked error handler allows :ref:`MPI_Waitall` to return to the caller, the value MPI_ERR_IN_STATUS will be returned in the C and Fortran bindings. diff --git a/docs/man-openmpi/man3/MPI_Waitany.3.rst b/docs/man-openmpi/man3/MPI_Waitany.3.rst index 723d866de23..ad0eb895e9e 100644 --- a/docs/man-openmpi/man3/MPI_Waitany.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitany.3.rst @@ -110,17 +110,7 @@ special value for the *status* argument. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`, :ref:`MPI_File_set_errhandler`, or -:ref:`MPI_Win_set_errhandler` (depending on the type of MPI handle that -generated the request); the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst Note that per MPI-1 section 3.2.5, MPI errors on requests passed to :ref:`MPI_WAITANY` do not set the status.MPI_ERROR field in the returned diff --git a/docs/man-openmpi/man3/MPI_Waitsome.3.rst b/docs/man-openmpi/man3/MPI_Waitsome.3.rst index 0c76e2baffd..24a27022444 100644 --- a/docs/man-openmpi/man3/MPI_Waitsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitsome.3.rst @@ -140,6 +140,8 @@ range 1 to incount for Fortran. ERRORS ------ +.. include:: ./ERRORS.rst + For each invocation of :ref:`MPI_Waitsome`, if one or more requests generate an MPI error, only the *first* MPI request that caused an error will be passed to its corresponding error handler. No other error handlers will @@ -148,14 +150,6 @@ requests that generate an error will have a relevant error code set in the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was used). -The default error handler aborts the MPI job, except for I/O function -errors. The error handler may be changed with :ref:`MPI_Comm_set_errhandler`, -:ref:`MPI_File_set_errhandler`, or :ref:`MPI_Win_set_errhandler` (depending on the -type of MPI handle that generated the MPI request); the predefined error -handler MPI_ERRORS_RETURN may be used to cause error values to be -returned. Note that MPI does not guarantee that an MPI program can -continue past an error. - If the invoked error handler allows :ref:`MPI_Waitsome` to return to the caller, the value MPI_ERR_IN_STATUS will be returned in the C and Fortran bindings. diff --git a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst index a825142ea8a..c1303141de8 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst @@ -118,16 +118,7 @@ type.* ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_create` :ref:`MPI_Win_allocate_shared` diff --git a/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst b/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst index 63d29a01bd3..50bf97ce264 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst @@ -138,16 +138,7 @@ type. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_allocate` :ref:`MPI_Win_create` diff --git a/docs/man-openmpi/man3/MPI_Win_attach.3.rst b/docs/man-openmpi/man3/MPI_Win_attach.3.rst index b69995bb05f..2afcd093b7d 100644 --- a/docs/man-openmpi/man3/MPI_Win_attach.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_attach.3.rst @@ -102,12 +102,4 @@ and so on). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst index 53efe0a77b8..0cdc9226bb1 100644 --- a/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst @@ -77,11 +77,7 @@ window. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -See the MPI man page for a full list of MPI error codes. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_create_errhandler` :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Win_complete.3.rst b/docs/man-openmpi/man3/MPI_Win_complete.3.rst index 7a19c80e5ce..2c9414e1d8b 100644 --- a/docs/man-openmpi/man3/MPI_Win_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_complete.3.rst @@ -66,16 +66,7 @@ not have completed at the target when it has completed at the origin. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_start` diff --git a/docs/man-openmpi/man3/MPI_Win_create.3.rst b/docs/man-openmpi/man3/MPI_Win_create.3.rst index bb5d699d76b..08850a7b30e 100644 --- a/docs/man-openmpi/man3/MPI_Win_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create.3.rst @@ -156,16 +156,7 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_allocate` :ref:`MPI_Win_allocate_shared` diff --git a/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst b/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst index dc9df473917..599896e7ce2 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst @@ -111,16 +111,7 @@ correct offset calculations with proper type handling. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_attach` :ref:`MPI_Win_detach` :ref:`MPI_Get_address` diff --git a/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst index 98d4c9d2a3e..abd01cfe3ae 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst @@ -90,12 +90,4 @@ In Fortran, the user routine should be of the form: ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst index 0a210c757d1..3c1a50c77a8 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst @@ -133,12 +133,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst index 4032a818c55..2c2128ed642 100644 --- a/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst @@ -71,12 +71,4 @@ being invoked. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_fence.3.rst b/docs/man-openmpi/man3/MPI_Win_fence.3.rst index 3630dff201c..87554e76622 100644 --- a/docs/man-openmpi/man3/MPI_Win_fence.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_fence.3.rst @@ -113,16 +113,7 @@ or accumulate that are synchronized with fence calls. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_create` :ref:`MPI_Win_start` :ref:`MPI_Win_post` :ref:`MPI_Win_complete` :ref:`MPI_Win_wait` diff --git a/docs/man-openmpi/man3/MPI_Win_flush.3.rst b/docs/man-openmpi/man3/MPI_Win_flush.3.rst index e6ac436b237..51ab29ee531 100644 --- a/docs/man-openmpi/man3/MPI_Win_flush.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_flush.3.rst @@ -80,17 +80,7 @@ Can only be called from within a passive target epoch. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_flush_local` :ref:`MPI_Win_lock` :ref:`MPI_Win_lock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst b/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst index ec711b502a8..fafee2885fe 100644 --- a/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst @@ -81,17 +81,7 @@ Can only be called from within a passive target epoch. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_flush` :ref:`MPI_Win_lock` :ref:`MPI_Win_lock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_free.3.rst b/docs/man-openmpi/man3/MPI_Win_free.3.rst index 24e945b4e72..86d5b3624f1 100644 --- a/docs/man-openmpi/man3/MPI_Win_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free.3.rst @@ -76,16 +76,7 @@ call will be freed when calling :ref:`MPI_Win_free`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_create` :ref:`MPI_Win_allocate` :ref:`MPI_Win_allocate_shared` diff --git a/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst index df0bf95e475..7a1fa3019c0 100644 --- a/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst @@ -56,12 +56,4 @@ OUTPUT PARAMETER ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst index ca4eacb7eba..9a5de2029dd 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst @@ -86,12 +86,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst index 50676923c48..97522d03b5e 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst @@ -66,12 +66,4 @@ with a window. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_get_group.3.rst b/docs/man-openmpi/man3/MPI_Win_get_group.3.rst index 0509ac708c1..806eb74f35f 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_group.3.rst @@ -67,12 +67,4 @@ in *group*. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_get_info.3.rst b/docs/man-openmpi/man3/MPI_Win_get_info.3.rst index 14ab3481bf2..36de3883ccf 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_info.3.rst @@ -69,16 +69,7 @@ info_used via :ref:`MPI_Info_free`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_set_info` :ref:`MPI_Win_free` diff --git a/docs/man-openmpi/man3/MPI_Win_get_name.3.rst b/docs/man-openmpi/man3/MPI_Win_get_name.3.rst index 118b0ff3de1..197fd16a0cc 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_name.3.rst @@ -65,12 +65,4 @@ DESCRIPTION ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_lock.3.rst b/docs/man-openmpi/man3/MPI_Win_lock.3.rst index e14d30b338d..9cb96cfd893 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock.3.rst @@ -97,16 +97,7 @@ failing to notice that the peer MPI job has terminated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_unlock` :ref:`MPI_Win_lock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst b/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst index 9f16f5ea14d..5da8cc5365a 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst @@ -98,16 +98,7 @@ call, failing to notice that the peer MPI job has terminated. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_unlock_all` :ref:`MPI_Win_lock` diff --git a/docs/man-openmpi/man3/MPI_Win_post.3.rst b/docs/man-openmpi/man3/MPI_Win_post.3.rst index 049aeb59c86..c3b0f1aa76d 100644 --- a/docs/man-openmpi/man3/MPI_Win_post.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_post.3.rst @@ -88,16 +88,7 @@ MPI_MODE_NOPUT ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_start` :ref:`MPI_Win_wait` diff --git a/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst index 6a25651a5a3..6d90e117d59 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst @@ -83,12 +83,4 @@ length of the declared integer in bytes. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst index 35d8be91719..7e8990f0840 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst @@ -69,12 +69,4 @@ handler created by a call to :ref:`MPI_Win_create_errhandler`. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_set_info.3.rst b/docs/man-openmpi/man3/MPI_Win_set_info.3.rst index 612041bba3e..806105995db 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_info.3.rst @@ -68,16 +68,7 @@ the same value in each process's *info* object. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_get_info` :ref:`MPI_Info_create` :ref:`MPI_Info_set` :ref:`MPI_Info_free` diff --git a/docs/man-openmpi/man3/MPI_Win_set_name.3.rst b/docs/man-openmpi/man3/MPI_Win_set_name.3.rst index a8efa1e236d..f16fda9e8f7 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_name.3.rst @@ -66,12 +66,4 @@ DESCRIPTION ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst b/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst index a7b06cdc29a..f4c4300cb7d 100644 --- a/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst @@ -95,16 +95,7 @@ pointer to a pointer of arbitrary type (e.g. *void \*\**). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Alloc_mem` :ref:`MPI_Win_allocate_shared` diff --git a/docs/man-openmpi/man3/MPI_Win_start.3.rst b/docs/man-openmpi/man3/MPI_Win_start.3.rst index bdf73419ebb..de119baa408 100644 --- a/docs/man-openmpi/man3/MPI_Win_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_start.3.rst @@ -81,16 +81,7 @@ MPI_MODE_NOCHECK ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_post` :ref:`MPI_Win_complete` diff --git a/docs/man-openmpi/man3/MPI_Win_sync.3.rst b/docs/man-openmpi/man3/MPI_Win_sync.3.rst index 7b9079d67b5..b9ccbf04d01 100644 --- a/docs/man-openmpi/man3/MPI_Win_sync.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_sync.3.rst @@ -67,13 +67,4 @@ epoch or complete any pending MPI RMA operations). ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler -MPI_ERRORS_RETURN may be used to cause error values to be returned. Note -that MPI does not guarantee that an MPI program can continue past an -error. +.. include:: ./ERRORS.rst diff --git a/docs/man-openmpi/man3/MPI_Win_test.3.rst b/docs/man-openmpi/man3/MPI_Win_test.3.rst index 21dd3d0781f..334f4178311 100644 --- a/docs/man-openmpi/man3/MPI_Win_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_test.3.rst @@ -74,16 +74,7 @@ window is posted anew. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_post` :ref:`MPI_Win_wait` diff --git a/docs/man-openmpi/man3/MPI_Win_unlock.3.rst b/docs/man-openmpi/man3/MPI_Win_unlock.3.rst index c80b91b0a38..64405d688e9 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock.3.rst @@ -76,16 +76,7 @@ protected by an exclusive lock to the same window. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_lock` :ref:`MPI_Win_unlock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst b/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst index b199fb40c06..3c389d2057c 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst @@ -74,16 +74,7 @@ protected by an exclusive lock to the same window. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_lock_all` :ref:`MPI_Win_unlock` diff --git a/docs/man-openmpi/man3/MPI_Win_wait.3.rst b/docs/man-openmpi/man3/MPI_Win_wait.3.rst index aec955bffa2..e559ba0675a 100644 --- a/docs/man-openmpi/man3/MPI_Win_wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_wait.3.rst @@ -71,16 +71,7 @@ target window. ERRORS ------ -Almost all MPI routines return an error value; C routines as the value -of the function and Fortran routines in the last argument. - -Before the error value is returned, the current MPI error handler is -called. By default, this error handler aborts the MPI job, except for -I/O function errors. The error handler may be changed with -:ref:`MPI_Win_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN -may be used to cause error values to be returned. Note that MPI does not -guarantee that an MPI program can continue past an error. - +.. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Win_post`