Skip to content

Commit ae44272

Browse files
committed
squashme: add on mpi_t_events man page
Signed-off-by: Howard Pritchard <[email protected]>
1 parent 782deaa commit ae44272

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. _mpi_t_source_get_num:
2+
3+
4+
MPI_T_source_get_num
5+
====================
6+
7+
.. include_body
8+
9+
:ref:`MPI_T_source_get_num` |mdash| Query the number of sources
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_source_get_num(int *num_sources)
24+
25+
26+
OUTPUT PARAMETERS
27+
-----------------
28+
* ``num_sources``: Current number of sources
29+
30+
DESCRIPTION
31+
-----------
32+
33+
:ref:`MPI_T_source_get_num` can be used to query the current number of
34+
sources.
35+
36+
37+
ERRORS
38+
------
39+
40+
:ref:`MPI_T_source_get_num` will fail if:
41+
42+
* ``MPI_T_ERR_NOT_INITIALIZED``: The MPI Tools interface not initialized

docs/man-openmpi/man3/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,7 @@ MPI API manual pages (section 3)
376376
MPI_T_pvar_start.3.rst
377377
MPI_T_pvar_stop.3.rst
378378
MPI_T_pvar_write.3.rst
379+
MPI_T_source_get_num.3.rst
379380
MPI_Test.3.rst
380381
MPI_Test_cancelled.3.rst
381382
MPI_Testall.3.rst

0 commit comments

Comments
 (0)