Skip to content

Commit a0fce4e

Browse files
committed
Fix the man pages for some of the MPI_T_* functions.
Signed-off-by: George Bosilca <bosilca@icl.utk.edu>
1 parent eed770c commit a0fce4e

File tree

6 files changed

+23
-7
lines changed

6 files changed

+23
-7
lines changed

ompi/mpi/man/man3/MPI_T_cvar_handle_alloc.3in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ int MPI_T_cvar_handle_alloc(int \fIcvar_index\fP, void *\fIobj_handle\fP,
2020

2121
int MPI_T_cvar_handle_free(MPI_T_cvar_handle *\fIhandle\fP)
2222

23+
.fi
2324
.SH DESCRIPTION
2425
.ft R
2526
MPI_T_cvar_handle_alloc binds the control variable specified in \fIcvar_index\fP to the MPI

ompi/mpi/man/man3/MPI_T_finalize.3in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
#include <mpi.h>
1616
int MPI_T_finalize(void)
1717

18+
.fi
1819
.SH DESCRIPTION
1920
.ft R
2021
MPI_T_finalize() finalizes the MPI tool information interface and must be called the same

ompi/mpi/man/man3/MPI_T_pvar_handle_alloc.3in

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,28 @@
1515
.SH C Syntax
1616
.nf
1717
#include <mpi.h>
18-
int MPI_T_pvar_handle_alloc(int \fIpvar_index\fP, void *\fIobj_handle\fP,
18+
int MPI_T_pvar_handle_alloc(int \fIsession\fP, int \fIpvar_index\fP, void *\fIobj_handle\fP,
1919
MPI_T_pvar_handle *\fIhandle\fP, int *\fIcount\fP)
2020

21-
int MPI_T_pvar_handle_free(MPI_T_pvar_handle *\fIhandle\fP)
21+
int MPI_T_pvar_handle_free(int \fIsession\fP, MPI_T_pvar_handle *\fIhandle\fP)
2222

2323
.SH DESCRIPTION
2424
.ft R
2525
MPI_T_pvar_handle_alloc binds the performance variable specified in \fIpvar_index\fP to the MPI
26-
object specified in \fIobj_handle\fP. If MPI_T_pvar_get_info returns MPI_T_BIND_NO_OBJECT
27-
as the binding for the variable the \fIobj_handle\fP argument is ignored. The number of
28-
values represented by this performance variable is returned in the \fIcount\fP parameter.
26+
object specified in \fIobj_handle\fP in the session identified by the parameter
27+
\fIsession\fP. The object is passed in the argument \fIobj_handle\fP as an
28+
address to a local variable that stores the object’s handle. If
29+
MPI_T_pvar_get_info returns MPI_T_BIND_NO_OBJECT as the binding
30+
for the variable the \fIobj_handle\fP argument is ignored. The handle
31+
allocated to reference the variable is returned in the argument \fIhandle\fP. Upon successful
32+
return, \fIcount\fP contains the number of elements (of the datatype returned by a previous
33+
MPI_T_PVAR_GET_INFO call) used to represent this variable.
34+
35+
The value of \fIpvar_index\fP should be in the range 0 to \fInum_pvar - 1\fP,
36+
where \fInum_pvar\fP is the number of available performance variables as
37+
determined from a prior call to \fIMPI_T_PVAR_GET_NUM\fP. The type of the
38+
MPI object it references must be consistent with the type returned in the
39+
bind argument in a prior call to \fIMPI_T_PVAR_GET_INFO\fP.
2940

3041
MPI_T_pvar_handle_free frees a handle allocated by MPI_T_pvar_handle_alloc and sets the
3142
\fIhandle\fP argument to MPI_T_PVAR_HANDLE_NULL.
@@ -50,11 +61,12 @@ MPI_T_pvar_handle_free() will fail if:
5061
The MPI Tools interface not initialized
5162
.TP 1i
5263
[MPI_T_ERR_INVALID_HANDLE]
53-
The handle is invalid
64+
The handle is invalid or the handle argument passed in is not associated with the session argument
5465

5566

5667
.SH SEE ALSO
5768
.ft R
5869
.nf
5970
MPI_T_pvar_get_info
71+
MPI_T_pvar_get_num
6072

ompi/mpi/man/man3/MPI_T_pvar_session_create.3in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ int MPI_T_pvar_session_create(MPI_T_pvar_session *\fIsession\fP)
1919

2020
int MPI_T_pvar_session_free(MPI_T_pvar_session *\fIsession\fP)
2121

22+
.fi
2223
.SH DESCRIPTION
2324
.ft R
2425
MPI_T_pvar_session_create creates a session for accessing performance variables. The

ompi/mpi/man/man3/MPI_T_pvar_start.3in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ int MPI_T_pvar_start(MPI_T_pvar_session \fIsession\fP, MPI_T_pvar_handle \fIhand
1919

2020
int MPI_T_pvar_stop(MPI_T_pvar_session \fIsession\fP, MPI_T_pvar_handle \fIhandle\fP)
2121

22+
.fi
2223
.SH INPUT PARAMETERS
2324
.ft R
2425
.TP 1i

ompi/mpi/man/man3/MPI_T_pvar_write.3in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Initial address of storage location for variable value.
3333
.SH DESCRIPTION
3434
.ft R
3535
MPI_T_pvar_write attempts to set the value of the performance variable identified by
36-
the handle specified in \fIhandle\fP in the session specified in \fPsession\fI. The
36+
the handle specified in \fIhandle\fP in the session specified in \fIsession\fP. The
3737
value to be written is specified in \fIbuf\fP. The caller must ensure that the buffer
3838
specified in \fIbuf\fP is large enough to hold the entire value of the performance
3939
variable.

0 commit comments

Comments
 (0)