Commit 60f9b7bf authored by Pavan Balaji's avatar Pavan Balaji
Browse files

[svn-r10546] Several manpage corrections:

1. Make the manpage entries consistent with the function prototype.

2. Consistently use "Parameters" instead of the inconsistent
"Parameter" and "Parameters" usage.

3. Correct the manpages for MPI_Type_get_contents and
MPI_Type_get_envelope.

Reviewed by dinan.
parent 741d33dc
......@@ -45,11 +45,11 @@ typedef struct realModel {
MPI_Type_create_f90_complex - Return a predefined type that matches
the specified range
Input Arguments:
Input Parameters:
+ precision - Number of decimal digits in mantissa
- range - Decimal range desired
Output Arguments:
Output Parameters:
. newtype - A predefine MPI Datatype that matches the range.
Notes:
......
......@@ -42,10 +42,10 @@ typedef struct intModel {
MPI_Type_create_f90_integer - Return a predefined type that matches
the specified range
Input Arguments:
Input Parameters:
. range - Decimal range (number of digits) desired
Output Arguments:
Output Parameters:
. newtype - A predefine MPI Datatype that matches the range.
Notes:
......
......@@ -44,11 +44,11 @@ typedef struct realModel {
MPI_Type_create_f90_real - Return a predefined type that matches
the specified range
Input Arguments:
Input Parameters:
+ precision - Number of decimal digits in mantissa
- range - Decimal exponent range desired
Output Arguments:
Output Parameters:
. newtype - A predefine MPI Datatype that matches the range.
Notes:
......
......@@ -85,11 +85,11 @@ int MPIR_Comm_create_keyval_impl(MPI_Comm_copy_attr_function *comm_copy_attr_fn,
MPI_Comm_create_keyval - Create a new attribute key
Input Parameters:
+ copy_fn - Copy callback function for 'keyval'
. delete_fn - Delete callback function for 'keyval'
+ comm_copy_attr_fn - Copy callback function for 'keyval'
. comm_delete_attr_fn - Delete callback function for 'keyval'
- extra_state - Extra state for callback functions
Output Parameter:
Output Parameters:
. comm_keyval - key value for future access (integer)
Notes:
......
......@@ -54,7 +54,7 @@ void MPIR_Comm_free_keyval_impl(int keyval)
/*@
MPI_Comm_free_keyval - Frees an attribute key for communicators
Input Parameter:
Input Parameters:
. comm_keyval - Frees the integer key value (integer)
Notes:
......
......@@ -319,10 +319,10 @@ int MPIR_CommGetAttr_fort(MPI_Comm comm, int comm_keyval, void *attribute_val,
Input Parameters:
+ comm - communicator to which attribute is attached (handle)
- keyval - key value (integer)
- comm_keyval - key value (integer)
Output Parameters:
+ attr_value - attribute value, unless 'flag' = false
+ attribute_val - attribute value, unless 'flag' = false
- flag - true if an attribute value was extracted; false if no attribute is
associated with the key
......
......@@ -185,7 +185,7 @@ int MPIR_CommSetAttr( MPI_Comm comm, int comm_keyval, void *attribute_val,
Input Parameters:
+ comm - communicator to which attribute will be attached (handle)
. keyval - key value, as returned by 'MPI_Comm_create_keyval' (integer)
. comm_keyval - key value, as returned by 'MPI_Comm_create_keyval' (integer)
- attribute_val - attribute value
Notes:
......
......@@ -37,7 +37,7 @@ Input Parameters:
. delete_fn - Delete callback function for 'keyval'
- extra_state - Extra state for callback functions
Output Parameter:
Output Parameters:
. keyval - key value for future access (integer)
Notes:
......
......@@ -33,7 +33,7 @@
MPI_Keyval_free - Frees an attribute key for communicators
Input Parameter:
Input Parameters:
. keyval - Frees the integer key value (integer)
Note:
......
......@@ -41,12 +41,12 @@
/*@
MPI_Type_create_keyval - Create an attribute keyval for MPI datatypes
Input Parameters:
Input Parameters:
+ type_copy_attr_fn - copy callback function for type_keyval (function)
. type_delete_attr_fn - delete callback function for type_keyval (function)
- extra_state - extra state for callback functions
Output Parameter:
Output Parameters:
. type_keyval - key value for future access (integer)
Notes:
......
......@@ -33,8 +33,8 @@
MPI_Type_delete_attr - Deletes an attribute value associated with a key on
a datatype
Input Parameters:
+ type - MPI datatype to which attribute is attached (handle)
Input Parameters:
+ datatype - MPI datatype to which attribute is attached (handle)
- type_keyval - The key value of the deleted attribute (integer)
.N ThreadSafe
......
......@@ -32,8 +32,8 @@
/*@
MPI_Type_free_keyval - Frees an attribute key for datatypes
Input Parameter:
. keyval - Frees the integer key value (integer)
Input Parameters:
. type_keyval - Frees the integer key value (integer)
.N ThreadSafe
......
......@@ -156,11 +156,11 @@ int MPIR_TypeGetAttr( MPI_Datatype datatype, int type_keyval, void *attribute_va
/*@
MPI_Type_get_attr - Retrieves attribute value by key
Input Parameters:
Input Parameters:
+ datatype - datatype to which the attribute is attached (handle)
- type_keyval - key value (integer)
Output Parameters:
Output Parameters:
+ attribute_val - attribute value, unless flag = false
- flag - false if no attribute is associated with the key (logical)
......
......@@ -166,7 +166,7 @@ int MPIR_TypeSetAttr(MPI_Datatype datatype, int type_keyval, void *attribute_val
Input Parameters:
+ datatype - MPI Datatype to which attribute will be attached (handle)
. keyval - key value, as returned by 'MPI_Type_create_keyval' (integer)
. type_keyval - key value, as returned by 'MPI_Type_create_keyval' (integer)
- attribute_val - attribute value
Notes:
......
......@@ -41,12 +41,12 @@
/*@
MPI_Win_create_keyval - Create an attribute keyval for MPI window objects
Input Parameters:
Input Parameters:
+ win_copy_attr_fn - copy callback function for win_keyval (function)
. win_delete_attr_fn - delete callback function for win_keyval (function)
- extra_state - extra state for callback functions
Output Parameter:
Output Parameters:
. win_keyval - key value for future access (integer)
Notes:
......
......@@ -33,7 +33,7 @@
MPI_Win_delete_attr - Deletes an attribute value associated with a key on
a datatype
Input Parameters:
Input Parameters:
+ win - window from which the attribute is deleted (handle)
- win_keyval - key value (integer)
......
......@@ -32,7 +32,7 @@
/*@
MPI_Win_free_keyval - Frees an attribute key for MPI RMA windows
Input Parameter:
Input Parameters:
. win_keyval - key value (integer)
.N ThreadSafe
......
......@@ -223,11 +223,11 @@ int MPIR_WinGetAttr( MPI_Win win, int win_keyval, void *attribute_val,
/*@
MPI_Win_get_attr - Get attribute cached on an MPI window object
Input Parameters:
Input Parameters:
+ win - window to which the attribute is attached (handle)
- win_keyval - key value (integer)
Output Parameters:
Output Parameters:
+ attribute_val - attribute value, unless flag is false
- flag - false if no attribute is associated with the key (logical)
......
......@@ -173,7 +173,7 @@ int MPIR_WinSetAttr( MPI_Win win, int win_keyval, void *attribute_val,
Input Parameters:
+ win - MPI window object to which attribute will be attached (handle)
. keyval - key value, as returned by 'MPI_Win_create_keyval' (integer)
. win_keyval - key value, as returned by 'MPI_Win_create_keyval' (integer)
- attribute_val - attribute value
Notes:
......
......@@ -832,7 +832,7 @@ Input Parameters:
. recvtype - data type of receive buffer elements (handle)
- comm - communicator (handle)
Output Parameter:
Output Parameters:
. recvbuf - address of receive buffer (choice)
Notes:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment