Skip to content

Commit a7aef5e

Browse files
committed
more pr feedback
Signed-off-by: Howard Pritchard <howardp@lanl.gov>
1 parent 4638622 commit a7aef5e

File tree

5 files changed

+61
-16
lines changed

5 files changed

+61
-16
lines changed

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_handle_alloc.3.rst

Lines changed: 12 additions & 8 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,9 +42,6 @@ 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

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: 1 addition & 1 deletion
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
-----------

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)