ulfm-doc: Update to use ERRORS.rst; see-also format, syntax coloring

examples

Signed-off-by: Aurélien Bouteiller <[email protected]>

Author: abouteiller

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

@@ -121,15 +121,8 @@ in both the local and the remote groups of *comm* are acknowledged.
 ERRORS
 ------
 
-Almost all MPI routines return an error value; C routines as the value
-of the function and Fortran routines in the last argument.
-
-Before the error value is returned, the current MPI error handler is
-called. By default, this error handler aborts the MPI job, except for
-I/O function errors. The error handler may be changed with
-:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
-may be used to 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:`MPIX_Comm_get_failed` :ref:`MPIX_Comm_agree`
+   * :ref:`MPIX_Comm_get_failed`
+   * :ref:`MPIX_Comm_agree`

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

@@ -114,7 +114,7 @@ process in *comm*, all processes raise an error of class MPIX_ERR_PROC_FAILED.
 :ref:`MPIX_Comm_agree` users can propagate and synchronize the knowledge
 of failures across all MPI processes in *comm*.
 
-::
+.. code-block:: c
 
     Comm_get_failed_consistent(MPI_Comm c, MPI_Group * g) {
         int rc; int T=1;
@@ -168,15 +168,8 @@ the local and remote groups of the inter-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:`MPIX_Comm_is_revoked` :ref:`MPIX_Comm_ack_failed`
+   * :ref:`MPIX_Comm_is_revoked`
+   * :ref:`MPIX_Comm_ack_failed`

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

@@ -91,15 +91,8 @@ groups of *comm*.
 ERRORS
 ------
 
-Almost all MPI routines return an error value; C routines as the value
-of the function and Fortran routines in the last argument.
-
-Before the error value is returned, the current MPI error handler is
-called. By default, this error handler aborts the MPI job, except for
-I/O function errors. The error handler may be changed with
-:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
-may be used to 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:`MPIX_Comm_revoke` :ref:`MPIX_Comm_ack_failed`
+   * :ref:`MPIX_Comm_revoke`
+   * :ref:`MPIX_Comm_ack_failed`

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

@@ -107,15 +107,9 @@ and complete with their normal semantics on a revoked 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:`MPIX_Comm_revoke` :ref:`MPIX_Comm_agree` :ref:`MPIX_Comm_shrink`
+   * :ref:`MPIX_Comm_revoke`
+   * :ref:`MPIX_Comm_agree`
+   * :ref:`MPIX_Comm_shrink`

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

@@ -84,15 +84,9 @@ sender.
 ERRORS
 ------
 
-Almost all MPI routines return an error value; C routines as the value
-of the function and Fortran routines in the last argument.
-
-Before the error value is returned, the current MPI error handler is
-called. By default, this error handler aborts the MPI job, except for
-I/O function errors. The error handler may be changed with
-:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
-may be used to 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:`MPIX_Comm_is_revoked` :ref:`MPIX_Comm_agree` :ref:`MPIX_Comm_shrink`
+   * :ref:`MPIX_Comm_is_revoked`
+   * :ref:`MPIX_Comm_agree`
+   * :ref:`MPIX_Comm_shrink`

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

@@ -111,15 +111,7 @@ MPI operations on *newcomm*.
 ERRORS
 ------
 
-Almost all MPI routines return an error value; C routines as the value
-of the function and Fortran routines in the last argument.
-
-Before the error value is returned, the current MPI error handler is
-called. By default, this error handler aborts the MPI job, except for
-I/O function errors. The error handler may be changed with
-:ref:`MPI_Comm_set_errhandler`; the predefined error handler MPI_ERRORS_RETURN
-may be used to 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:`MPIX_Comm_is_revoked`
+   * :ref:`MPIX_Comm_is_revoked`