From: Stan Smith <stan.smith@intel.com>
Date: Tue, 25 May 2010 23:43:04 +0000 (+0000)
Subject: [INC] Correct spelling, white-space alignment, remove trailing white-space, add comments.
X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=4d64619d88e95274559ccf670d12be97810e0991;p=~shefty%2Frdma-win.git

[INC] Correct spelling, white-space alignment, remove trailing white-space, add comments.
Generally make ib_types.h more compatible with OFED for Linux version in order to make comparisions easier.

git-svn-id: svn://openib.tc.cornell.edu/gen1@2811 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86
---

diff --git a/trunk/inc/iba/ib_types.h b/trunk/inc/iba/ib_types.h
index e5dee9e7..14256d5a 100644
--- a/trunk/inc/iba/ib_types.h
+++ b/trunk/inc/iba/ib_types.h
@@ -280,8 +280,6 @@ extern "C"
 * SOURCE
 */
 #define IB_HOPLIMIT_MAX					255
-/*********/
-
 /*********/
 /****d* IBA Base: Constants/IB_MC_SCOPE_*
 * NAME
@@ -634,7 +632,7 @@ ib_class_is_vendor_specific_low(
 *		[in] The Management Datagram Class Code
 *
 * RETURN VALUE
-*	TRUE if the class is in the Low range of Vendor Specific MADs 
+*	TRUE if the class is in the Low range of Vendor Specific MADs
 *	FALSE otherwise.
 *
 * NOTES
@@ -666,7 +664,7 @@ ib_class_is_vendor_specific_high(
 *		[in] The Management Datagram Class Code
 *
 * RETURN VALUE
-*	TRUE if the class is in the High range of Vendor Specific MADs 
+*	TRUE if the class is in the High range of Vendor Specific MADs
 *	FALSE otherwise.
 *
 * NOTES
@@ -1033,7 +1031,7 @@ ib_class_is_rmpp(
 *	IB_MAD_ATTR_PORT_SMPL_CTRL
 *
 * DESCRIPTION
-*	NodeDescription attribute (16.1.2)
+*	PortSamplesControl attribute (16.1.3)
 *
 * SOURCE
 */
@@ -1057,7 +1055,7 @@ ib_class_is_rmpp(
 *	IB_MAD_ATTR_PORT_SMPL_RSLT
 *
 * DESCRIPTION
-*	NodeInfo attribute (16.1.2)
+*	PortSamplesResult attribute (16.1.3)
 *
 * SOURCE
 */
@@ -1081,7 +1079,7 @@ ib_class_is_rmpp(
 *	IB_MAD_ATTR_PORT_CNTRS
 *
 * DESCRIPTION
-*	SwitchInfo attribute (16.1.2)
+*	PortCounters attribute (16.1.3)
 *
 * SOURCE
 */
@@ -2492,7 +2490,7 @@ typedef __declspec(align(8)) struct _ib_path_rec
 *		Another global routing parameter.
 *
 *	num_path
-*     Reversible path - 1 bit to say if path is reversible.
+*		Reversible path - 1 bit to say if path is reversible.
 *		num_path [6:0] In queries, maximum number of paths to return.
 *		In responses, undefined.
 *
@@ -2848,7 +2846,7 @@ ib_path_rec_init_local(
 *		[in] LID of source port.
 *
 *	num_path
-*     [in] Reversible path - 1 bit to say if path is reversible.
+*		[in] Reversible path - 1 bit to say if path is reversible.
 *		num_path [6:0] In queries, maximum number of paths to return.
 *		In responses, undefined.
 *
@@ -2937,6 +2935,22 @@ ib_path_rec_set_sl(IN ib_path_rec_t * const p_rec, IN const uint8_t sl)
 	    (p_rec->qos_class_sl & CL_HTON16(IB_PATH_REC_QOS_CLASS_MASK)) |
 	    cl_hton16(sl & IB_PATH_REC_SL_MASK);
 }
+/*
+* PARAMETERS
+*	p_rec
+*		[in] Pointer to the path record object.
+*
+*	sl
+*		[in] Service level to set.
+*
+* RETURN VALUES
+*	None
+*
+* NOTES
+*
+* SEE ALSO
+*	ib_path_rec_t
+*********/
 
 /****f* IBA Base: Types/ib_path_rec_sl
 * NAME
@@ -3424,10 +3438,10 @@ typedef struct _ib_class_port_info
 *		Maximum expected response time and additional
 *		supported capabilities of this management class.
 *
-*	redr_gid
+*	redir_gid
 *		GID to use for redirection, or zero
 *
-*	recdir_tc_sl_fl
+*	redir_tc_sl_fl
 *		Traffic class, service level and flow label the requester
 *		should use if the service is redirected.
 *
@@ -4454,7 +4468,7 @@ ib_sa_mad_get_payload_ptr(
 *	ib_node_info_get_local_port_num
 *
 * DESCRIPTION
-*	Gets a the local port number from the NodeInfo attribute.
+*	Get the local port number from the NodeInfo attribute.
 *
 * SYNOPSIS
 */
@@ -5085,7 +5099,7 @@ ib_port_info_get_link_speed_active(
 #define IB_PATH_RECORD_RATE_120_GBS		10
 
 #define IB_MIN_RATE    IB_PATH_RECORD_RATE_2_5_GBS
-#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS 
+#define IB_MAX_RATE    IB_PATH_RECORD_RATE_120_GBS
 
 /****f* IBA Base: Types/ib_port_info_compute_rate
 * NAME
@@ -5276,7 +5290,7 @@ ib_port_info_get_mtu_cap(
 *		[in] Pointer to a PortInfo attribute.
 *
 * RETURN VALUES
-*	Returns the LMC value assigned to this port.
+*	Returns the encoded value for the maximum MTU supported by this port.
 *
 * NOTES
 *