Skip to content

Commit d0037fc

Browse files
hppritchahppritcha
committed
MPI_T events: man pages
Signed-off-by: Howard Pritchard <[email protected]>
1 parent 5622889 commit d0037fc

14 files changed

+128
-65
lines changed

‎docs/man-openmpi/man3/MPI_T.3.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,49 @@ Open MPI's MPI_T categories are organized hierarchically:
123123

124124

125125
.. seealso::
126+
* :ref:`MPI_T_category_changed`
127+
* :ref:`MPI_T_category_get_categories`
128+
* :ref:`MPI_T_category_get_cvars`
129+
* :ref:`MPI_T_category_get_info`
130+
* :ref:`MPI_T_category_get_num`
131+
* :ref:`MPI_T_category_get_pvars`
132+
* :ref:`MPI_T_cvar_get_info`
133+
* :ref:`MPI_T_cvar_get_num`
134+
* :ref:`MPI_T_cvar_handle_alloc`
135+
* :ref:`MPI_T_cvar_handle_free`
136+
* :ref:`MPI_T_cvar_read`
137+
* :ref:`MPI_T_cvar_write`
138+
* :ref:`MPI_T_enum_get_info`
139+
* :ref:`MPI_T_enum_get_item`
140+
* :ref:`MPI_T_event_callback_get_info`
141+
* :ref:`MPI_T_event_callback_set_info`
142+
* :ref:`MPI_T_event_copy`
143+
* :ref:`MPI_T_event_get_index`
144+
* :ref:`MPI_T_event_get_info`
145+
* :ref:`MPI_T_event_get_num`
146+
* :ref:`MPI_T_event_get_source`
147+
* :ref:`MPI_T_event_get_timestamp`
148+
* :ref:`MPI_T_event_handle_alloc`
149+
* :ref:`MPI_T_event_handle_free`
150+
* :ref:`MPI_T_event_handle_get_info`
151+
* :ref:`MPI_T_event_handle_set_info`
152+
* :ref:`MPI_T_event_read`
153+
* :ref:`MPI_T_event_register_callback`
154+
* :ref:`MPI_T_event_set_dropped_handler`
155+
* :ref:`MPI_T_finalize`
126156
* :ref:`MPI_T_init_thread`
157+
* :ref:`MPI_T_pvar_get_info`
158+
* :ref:`MPI_T_pvar_get_num`
159+
* :ref:`MPI_T_pvar_handle_alloc`
160+
* :ref:`MPI_T_pvar_handle_free`
161+
* :ref:`MPI_T_pvar_read`
162+
* :ref:`MPI_T_pvar_readreset`
163+
* :ref:`MPI_T_pvar_reset`
164+
* :ref:`MPI_T_pvar_session_create`
165+
* :ref:`MPI_T_pvar_session_free`
166+
* :ref:`MPI_T_pvar_start`
167+
* :ref:`MPI_T_pvar_stop`
168+
* :ref:`MPI_T_pvar_write`
169+
* :ref:`MPI_T_source_get_info`
170+
* :ref:`MPI_T_source_get_num`
171+
* :ref:`MPI_T_source_get_timestamp`

‎docs/man-openmpi/man3/MPI_T_ERRORS.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface is not initialized.
2+
3+
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid.
4+
5+
* ``MPI_T_ERR_INVALID_HANDLE``: Invalid use of the interface or bad parameter values(s).
6+
7+
* ``MPI_T_ERR_OTHER``: Other error

‎docs/man-openmpi/man3/MPI_T_event_callback_get_info.3.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,13 @@ DESCRIPTION
3737
-----------
3838

3939
:ref:`MPI_T_event_callback_get_info` returns a new info object containing the
40-
hints of the callback function registered for the callback safety level specified by `cb_safety` of
41-
the event-registration handle associated with `event_registration`.
40+
hints of the callback function registered for the callback safety level specified by ``cb_safety`` of
41+
the event-registration handle associated with ``event_registration``.
4242

4343

4444
ERRORS
4545
------
4646

4747
:ref:`MPI_T_event_callback_get_info` will fail if:
4848

49-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
50-
51-
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
52-
53-
* ``MPI_T_ERR_INVALID_HANDLE``: Invalid use of the interface or bad parameter values(s).
54-
55-
* ``MPI_T_ERR_OTHER``: Other error
49+
.. include:: ./MPI_T_ERRORS.rst

‎docs/man-openmpi/man3/MPI_T_event_callback_set_info.3.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,12 @@ INPUT PARAMETERS
3232
DESCRIPTION
3333
-----------
3434

35-
:ref:`MPI_T_event_callback_set_info` Updates the hints of the callback function registered for the callback safety level specified by `cb_safety` of the event-registration handle associated with event_registration.
35+
:ref:`MPI_T_event_callback_set_info` Updates the hints of the callback function registered for the callback safety level specified by ``cb_safety`` of the event-registration handle associated with event_registration.
3636

3737

3838
ERRORS
3939
------
4040

4141
:ref:`MPI_T_event_callback_set_info` will fail if:
4242

43-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
44-
45-
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
46-
47-
* ``MPI_T_ERR_INVALID_HANDLE``: Invalid use of the interface or bad parameter values(s).
48-
49-
* ``MPI_T_ERR_OTHER``: Other error
43+
.. include:: ./MPI_T_ERRORS.rst

‎docs/man-openmpi/man3/MPI_T_event_copy.3.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,7 @@ ERRORS
4141

4242
:ref:`MPI_T_event_copy` will fail if:
4343

44-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
45-
46-
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
47-
48-
* ``MPI_T_ERR_INVALID``: Invalid use of the interface or bad parameter values(s).
49-
44+
.. include:: ./MPI_T_ERRORS.rst
5045

5146
.. seealso::
5247
* :ref:`MPI_T_event_read`

‎docs/man-openmpi/man3/MPI_T_event_get_info.3.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ OUTPUT PARAMETERS
4040
-----------------
4141
* ``name``: Buffer to return the string containing the name of the event type.
4242
* ``verbosity``: Verbosity level of this event type
43-
* ``array_of_datatypes``: Array of mpi basic datatypes used to encode the event data
43+
* ``array_of_datatypes``: Array of MPI basic datatypes used to encode the event data
4444
* ``array_of_displacements``: Array of byte displacements of the elements in the event buffer
4545
* ``enumtype``: Optional descriptor for enumeration information
4646
* ``info``: Optional info argument.
4747
* ``desc``: Buffer to return the string containing the description of the event type.
48-
* ``bind``: Type of mpi object to which an event of this type must be bound
48+
* ``bind``: Type of MPI object to which an event of this type must be bound
4949

5050
DESCRIPTION
5151
-----------

‎docs/man-openmpi/man3/MPI_T_event_get_source.3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ OUTPUT PARAMETERS
3434
DESCRIPTION
3535
-----------
3636

37-
:ref:`MPI_T_event_get_source` returns the index of the source of `event_instance`.
37+
:ref:`MPI_T_event_get_source` returns the index of the source of ``event_instance``.
3838

3939
ERRORS
4040
------

‎docs/man-openmpi/man3/MPI_T_event_get_timestamp.3.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,4 @@ ERRORS
4343

4444
:ref:`MPI_T_event_get_timestamp` will fail if:
4545

46-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
47-
48-
* ``MPI_T_ERR_INVALID_INDEX``: The handle is invalid
49-
50-
* ``MPI_T_ERR_INVALID``: Invalid use of the interface or bad parameter values(s)
46+
.. include:: ./MPI_T_ERRORS.rst

‎docs/man-openmpi/man3/MPI_T_event_handle_alloc.3.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ MPI_T_event_handle_alloc
66

77
.. include_body
88
9-
:ref:`MPI_T_event_handle_alloc`, :ref:`MPI_T_event_handle_free` - Allocate/free
10-
event handles
9+
:ref:`MPI_T_event_handle_alloc` - Allocate event handles
1110

1211

1312
SYNTAX
@@ -21,11 +20,19 @@ C Syntax
2120
2221
#include <mpi.h>
2322
24-
int MPI_T_event_handle_alloc(int event_index, void *obj_handle,
23+
int MPI_T_event_handle_alloc(int event_index, void *obj_handle, MPI info,
2524
MPI_T_event_registration *event_registration)
2625
27-
int MPI_T_event_handle_free(MPI_T_event_registration event_registration,
28-
void *user_data, MPI_T_event_free_cb_function free_cb_function)
26+
INPUT PARAMETERS
27+
----------------
28+
* ``event_index``: Index of event type for which the registration handle is to be allocated.
29+
* ``obj_handle``: reference to a handle of the MPI object to which this event is supposed to be bound.
30+
* ``info``: Info object.
31+
32+
OUTPUT PARAMETERS
33+
-----------------
34+
* ``event_registration``: Event registration.
35+
2936

3037
DESCRIPTION
3138
-----------
@@ -35,19 +42,12 @@ DESCRIPTION
3542
:ref:`MPI_T_event_get_info` returns MPI_T_BIND_NO_OBJECT as the binding of the
3643
variable the *obj_handle* argument is ignored.
3744

38-
:ref:`MPI_T_event_handle_free` frees a handle allocated by
39-
:ref:`MPI_T_event_handle_alloc`.
40-
4145
ERRORS
4246
------
4347

4448
:ref:`MPI_T_event_handle_alloc` will fail if:
4549

46-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
47-
48-
* ``MPI_T_ERR_INVALID_INDEX``: The supplied event index is invalid
49-
50-
* ``MPI_T_ERR_INVALID``: The supplied input parameter is invalid
50+
.. include:: ./MPI_T_ERRORS.rst
5151

5252
.. seealso::
5353
* :ref:`MPI_T_event_get_info`

‎docs/man-openmpi/man3/MPI_T_event_handle_free.3.rst

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,50 @@
11
.. _mpi_t_event_handle_free:
22

3+
34
MPI_T_event_handle_free
45
=======================
5-
.. include_body
66

7-
.. include:: ../man3/MPI_T_event_handle_alloc.3.rst
8-
:start-after: .. include_body
7+
.. include_body
8+
9+
:ref:`MPI_T_event_handle_free` - Free event handles
10+
11+
12+
SYNTAX
13+
------
14+
15+
16+
C Syntax
17+
^^^^^^^^
18+
19+
.. code-block:: c
20+
21+
#include <mpi.h>
22+
23+
int MPI_T_event_handle_free(MPI_T_event_registration event_registration,
24+
void *user_data, MPI_T_event_free_cb_function free_cb_function)
25+
26+
INPUT PARAMETERS
27+
----------------
28+
* ``user_data``: Pointer to a user-controlled buffer.
29+
* ``free_cb_function``: Pointer to user-defined callback function.
30+
31+
INPUT/OUTPUT PARAMETERS
32+
-----------------------
33+
* ``event_registration``: Event registration.
34+
35+
36+
DESCRIPTION
37+
-----------
38+
39+
:ref:`MPI_T_event_handle_free` frees a handle allocated by
40+
:ref:`MPI_T_event_handle_alloc`.
41+
42+
ERRORS
43+
------
44+
45+
:ref:`MPI_T_event_handle_free` will fail if:
46+
47+
.. include:: ./MPI_T_ERRORS.rst
948

49+
.. seealso::
50+
* :ref:`MPI_T_event_get_info`

‎docs/man-openmpi/man3/MPI_T_event_read.3.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ INPUT PARAMETERS
2727
----------------
2828
* ``event_instance``: event-instance handle provided to the callback function.
2929
* ``elem_index``: index into the array of datatypes of the item to be queried.
30-
* ``buf``: pointer to a memory location to store the item data
30+
* ``buffer``: pointer to a memory location to store the item data
3131

3232
DESCRIPTION
3333
-----------
@@ -40,12 +40,7 @@ ERRORS
4040

4141
:ref:`MPI_T_event_read` will fail if:
4242

43-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
44-
45-
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
46-
47-
* ``MPI_T_ERR_INVALID``: Invalid use of the interface or bad parameter values(s).
48-
43+
.. include:: ./MPI_T_ERRORS.rst
4944

5045
.. seealso::
5146
* :ref:`MPI_T_event_copy`

‎docs/man-openmpi/man3/MPI_T_event_register_callback.3.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ DESCRIPTION
3737
-----------
3838

3939
:ref:`MPI_T_event_register_callback` associates a user-defined function pointed to
40-
by `event_cb_function` with an allocated event-registration handle. The maximum callback
41-
safety level supported by the callback function is passed in the argument `cb_safety`.
40+
by ``event_cb_function`` with an allocated event-registration handle. The maximum callback
41+
safety level supported by the callback function is passed in the argument ``cb_safety``.
4242

4343

4444
ERRORS

‎docs/man-openmpi/man3/MPI_T_event_set_dropped_handler.3.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,13 @@ DESCRIPTION
3333
-----------
3434

3535
:ref:`MPI_T_event_set_dropped_handler` registers the function
36-
`dropped_cb_function` to be called by the MPI implementation when event information is
37-
dropped for the registration handle specified in `event_registration`.
36+
``dropped_cb_function`` to be called by the MPI implementation when event information is
37+
dropped for the registration handle specified in ``event_registration``.
3838

3939

4040
ERRORS
4141
------
4242

4343
:ref:`MPI_T_event_set_dropped_handler` will fail if:
4444

45-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
46-
47-
* ``MPI_T_ERR_INVALID_HANDLE``: The handle is invalid
48-
49-
* ``MPI_T_ERR_OTHER``: Other error
45+
.. include:: ./MPI_T_ERRORS.rst

‎docs/man-openmpi/man3/MPI_T_source_get_info.3.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ C Syntax
2121
#include <mpi.h>
2222
2323
int MPI_T_source_get_info(int source_index, char *name, int *name_len,
24-
char *desc, int *desc_len, MPI_T_source_order *ordering,
25-
MPI_Count *ticks_per_second, MPI_Count *max_ticks, MPI_Info *info)
24+
char *desc, int *desc_len, MPI_T_source_order *ordering,
25+
MPI_Count *ticks_per_second, MPI_Count *max_ticks, MPI_Info *info)
2626
2727
2828
INPUT PARAMETERS

0 commit comments

Comments
 (0)