Skip to content

Commit 3329226

Browse files
committed
squashme suggestions for MPI_T_events man pages
Signed-off-by: Jeff Squyres <[email protected]>
1 parent ae44272 commit 3329226

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

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

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MPI_T_source_get_num
66

77
.. include_body
88
9-
:ref:`MPI_T_source_get_num` |mdash| Query the number of sources
9+
:ref:`MPI_T_source_get_num` |mdash| Query the number of MPI_T event sources
1010

1111

1212
SYNTAX
@@ -25,18 +25,33 @@ C Syntax
2525
2626
OUTPUT PARAMETERS
2727
-----------------
28+
2829
* ``num_sources``: Current number of sources
2930

31+
3032
DESCRIPTION
3133
-----------
3234

3335
:ref:`MPI_T_source_get_num` can be used to query the current number of
34-
sources.
36+
MPI_T event sources.
37+
38+
The number of available event sources can be queried with a call to
39+
:ref:`MPI_T_Source_get_num`. An MPI implementation is allowed to
40+
increase the number of sources during the execution of an MPI
41+
process. However, MPI implementations are not allowed to change the
42+
index of an event source or to delete an event source once it has been
43+
made visible to the user (e.g., if new event sources become available
44+
via dynamic loading of additional components in the MPI
45+
implementation).
46+
47+
.. note:: Open MPI will currently return that there are 0 sources of
48+
MPI_T events.
3549

3650

3751
ERRORS
3852
------
3953

4054
:ref:`MPI_T_source_get_num` will fail if:
4155

42-
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized
56+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface is not
57+
initialized

0 commit comments

Comments
 (0)