Fix the man pages for some of the MPI_T_* functions.

Signed-off-by: George Bosilca <[email protected]>

Author: bosilca

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

@@ -20,6 +20,7 @@ int MPI_T_cvar_handle_alloc(int \fIcvar_index\fP, void *\fIobj_handle\fP,
 
 int MPI_T_cvar_handle_free(MPI_T_cvar_handle *\fIhandle\fP)
 
+.fi
 .SH DESCRIPTION
 .ft R
 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

@@ -15,6 +15,7 @@
 #include <mpi.h>
 int MPI_T_finalize(void)
 
+.fi
 .SH DESCRIPTION
 .ft R
 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

@@ -15,17 +15,28 @@
 .SH C Syntax
 .nf
 #include <mpi.h>
-int MPI_T_pvar_handle_alloc(int \fIpvar_index\fP, void *\fIobj_handle\fP,
+int MPI_T_pvar_handle_alloc(int \fIsession\fP, int \fIpvar_index\fP, void *\fIobj_handle\fP,
                             MPI_T_pvar_handle *\fIhandle\fP, int *\fIcount\fP)
 
-int MPI_T_pvar_handle_free(MPI_T_pvar_handle *\fIhandle\fP)
+int MPI_T_pvar_handle_free(int \fIsession\fP, MPI_T_pvar_handle *\fIhandle\fP)
 
 .SH DESCRIPTION
 .ft R
 MPI_T_pvar_handle_alloc binds the performance variable specified in \fIpvar_index\fP to the MPI
-object specified in \fIobj_handle\fP. If MPI_T_pvar_get_info returns MPI_T_BIND_NO_OBJECT
-as the binding for the variable the \fIobj_handle\fP argument is ignored. The number of
-values represented by this performance variable is returned in the \fIcount\fP parameter.
+object specified in \fIobj_handle\fP in the session identified by the parameter
+\fIsession\fP. The object is passed in the argument \fIobj_handle\fP as an
+address to a local variable that stores the object’s handle. If
+MPI_T_pvar_get_info returns MPI_T_BIND_NO_OBJECT as the binding
+for the variable the \fIobj_handle\fP argument is ignored. The handle
+allocated to reference the variable is returned in the argument \fIhandle\fP. Upon successful
+return, \fIcount\fP contains the number of elements (of the datatype returned by a previous
+MPI_T_PVAR_GET_INFO call) used to represent this variable.
+
+The value of \fIpvar_index\fP should be in the range 0 to \fInum_pvar - 1\fP,
+where \fInum_pvar\fP is the number of available performance variables as
+determined from a prior call to \fIMPI_T_PVAR_GET_NUM\fP. The type of the
+MPI object it references must be consistent with the type returned in the
+bind argument in a prior call to \fIMPI_T_PVAR_GET_INFO\fP.
 
 MPI_T_pvar_handle_free frees a handle allocated by MPI_T_pvar_handle_alloc and sets the
 \fIhandle\fP argument to MPI_T_PVAR_HANDLE_NULL.
@@ -50,11 +61,12 @@ MPI_T_pvar_handle_free() will fail if:
 The MPI Tools interface not initialized
 .TP 1i
 [MPI_T_ERR_INVALID_HANDLE]
-The handle is invalid
+The handle is invalid or the handle argument passed in is not associated with the session argument
 
 
 .SH SEE ALSO
 .ft R
 .nf
 MPI_T_pvar_get_info
+MPI_T_pvar_get_num
 

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

@@ -19,6 +19,7 @@ int MPI_T_pvar_session_create(MPI_T_pvar_session *\fIsession\fP)
 
 int MPI_T_pvar_session_free(MPI_T_pvar_session *\fIsession\fP)
 
+.fi
 .SH DESCRIPTION
 .ft R
 MPI_T_pvar_session_create creates a session for accessing performance variables. The

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

@@ -19,6 +19,7 @@ int MPI_T_pvar_start(MPI_T_pvar_session \fIsession\fP, MPI_T_pvar_handle \fIhand
 
 int MPI_T_pvar_stop(MPI_T_pvar_session \fIsession\fP, MPI_T_pvar_handle \fIhandle\fP)
 
+.fi
 .SH INPUT PARAMETERS
 .ft R
 .TP 1i

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

@@ -33,7 +33,7 @@ Initial address of storage location for variable value.
 .SH DESCRIPTION
 .ft R
 MPI_T_pvar_write attempts to set the value of the performance variable identified by
-the handle specified in \fIhandle\fP in the session specified in \fPsession\fI. The
+the handle specified in \fIhandle\fP in the session specified in \fIsession\fP. The
 value to be written is specified in \fIbuf\fP. The caller must ensure that the buffer
 specified in \fIbuf\fP is large enough to hold the entire value of the performance
 variable.