Skip to content

Commit 87a5e09

Browse files
zerothijsquyres
authored andcommitted
doc: more cleaning of references
Also removed mentioning of some C++ bindings. It seemed weird to only have them in the *create_errhandler documents, hence removed. Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent cbc4601 commit 87a5e09

File tree

5 files changed

+28
-27
lines changed

5 files changed

+28
-27
lines changed

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,10 @@ Fortran 2008 Syntax
4848
Deprecated Type Name Note
4949
-------------------------
5050

51-
MPI-2.2 deprecated the MPI_Comm_errhandler_fn and
52-
``MPI::Comm::Errhandler_fn`` types in favor of
53-
MPI_Comm_errhandler_function and ``MPI::Comm::Errhandler_function``,
54-
respectively. Open MPI supports both names (indeed, the \_fn names are
55-
typedefs to the \_function names).
51+
MPI-2.2 deprecated the ``MPI_Comm_errhandler_fn`` type in favor of
52+
``MPI_Comm_errhandler_function``.
53+
Open MPI supports both names (indeed, the ``_fn`` names are
54+
typedefs to the ``_function`` names).
5655

5756
INPUT PARAMETER
5857
---------------
@@ -72,7 +71,7 @@ DESCRIPTION
7271
attached to communicators. This ``function`` is identical to
7372
:ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the
7473
user routine should be a ``function`` of type
75-
MPI_Comm_errhandler_function, which is defined as
74+
``MPI_Comm_errhandler_function``, which is defined as
7675

7776
.. code-block:: c
7877

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ Fortran Syntax
3838
3939
INPUT PARAMETER
4040
---------------
41+
4142
* ``function``: User-defined error handling procedure.
4243

4344
OUTPUT PARAMETERS
4445
-----------------
46+
4547
* ``errhandler``: MPI error handler (handle).
4648
* ``ierror``: Fortran only: Error status (integer).
4749

@@ -76,7 +78,7 @@ NOTE
7678

7779
The MPI-1 Standard states that an implementation may make the output
7880
value (errhandler) simply the address of the function. However, the
79-
action of MPI_Errhandler\_ free makes this impossible, since it is
81+
action of :ref:`MPI_Errhandler_free` makes this impossible, since it is
8082
required to set the value of the argument to MPI_ERRHANDLER_NULL. In
8183
addition, the actual error handler must remain until all communicators
8284
that use it are freed.

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

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,36 +52,35 @@ Fortran 2008 Syntax
5252
DEPRECATED TYPE NAME NOTE
5353
-------------------------
5454

55-
MPI-2.2 deprecated the MPI_File_errhandler_fn and
56-
MPI::file::Errhandler_fn types in favor of MPI_File_errhandler_function
57-
and MPI::File::Errhandler_function, respectively. Open MPI supports both
58-
names (indeed, the \_fn names are typedefs to the \_function names).
55+
MPI-2.2 deprecated the ``MPI_File_errhandler_fn`` type in favor of
56+
``MPI_File_errhandler_function``. Open MPI supports both
57+
names (indeed, the ``_fn`` names are typedefs to the ``_function`` names).
5958

6059

6160
INPUT PARAMETER
6261
---------------
62+
6363
* ``function``: User-defined error handling procedure (function).
6464

6565
OUTPUT PARAMETERS
6666
-----------------
67+
6768
* ``errhandler``: MPI error handler (handle).
6869
* ``ierror``: Fortran only: Error status (integer).
6970

7071
DESCRIPTION
7172
-----------
7273

73-
Registers the user routine *function* for use as an MPI error handler.
74-
Returns in errhandler a handle to the registered error handler.
74+
:ref:`MPI_Comm_create_errhandler` creates an error handler that can be
75+
attached to file operations. In C, the
76+
user routine should be a ``function`` of type
77+
``MPI_File_errhandler_function``, which is defined as
7578

76-
In the C language, the user routine *function* should be a C function of
77-
type MPI_File_errhandler_function, which is defined as
78-
79-
::
79+
.. code-block:: c
8080
81-
typedef void (MPI_File_errhandler_function)(MPI_File *, int *,
82-
...);
81+
typedef void (MPI_File_errhandler_function)(MPI_File *, int *, ...);
8382
84-
The first argument to *function* is the file in use. The second is the
83+
The first argument is the file in use. The second is the
8584
error code to be returned by the MPI routine that raised the error.
8685

8786
In the Fortran language, the user routine should be of the form:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ DESCRIPTION
6363
attached to sessions. This ``function`` is identical to
6464
:ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the
6565
user routine should be a ``function`` of type
66-
MPI_Session_errhandler_function, which is defined as
66+
``MPI_Session_errhandler_function``, which is defined as
6767

6868
.. code-block:: c
6969

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,28 +51,29 @@ Fortran 2008 Syntax
5151
DEPRECATED TYPE NAME NOTE
5252
-------------------------
5353

54-
MPI-2.2 deprecated the MPI_Win_errhandler_fn and MPI::Win::Errhandler_fn
55-
types in favor of MPI_Win_errhandler_function and
56-
MPI::Win::Errhandler_function, respectively. Open MPI supports both
57-
names (indeed, the \_fn names are typedefs to the \_function names).
54+
MPI-2.2 deprecated the ``MPI_Win_errhandler_fn`` type in favor of
55+
``MPI_Win_errhandler_function``. Open MPI supports both
56+
names (indeed, the ``_fn`` names are typedefs to the ``_function`` names).
5857

5958

6059
INPUT PARAMETER
6160
---------------
61+
6262
* ``function``: User-defined error-handling procedure (function).
6363

6464
OUTPUT PARAMETERS
6565
-----------------
66+
6667
* ``errhandler``: MPI error handler (handle).
6768
* ``ierror``: Fortran only: Error status (integer).
6869

6970
DESCRIPTION
7071
-----------
7172

7273
:ref:`MPI_Win_create_errhandler` should be, in C, a function of type
73-
MPI_Win_errhandler_function, which is defined as
74+
``MPI_Win_errhandler_function``, which is defined as
7475

75-
::
76+
.. code-block:: c
7677
7778
typedef void MPI_Win_errhandler_function(MPI Win *, int *, ...);
7879

0 commit comments

Comments
 (0)