[opensm,v2] opensm/osm_node.h: Improves comments

Commit Message

Honggang LI Nov. 6, 2018, 1:28 p.m. UTC

From: Honggang Li <[e-mail]>

Signed-off-by: Honggang Li <[e-mail]>
---
 include/opensm/osm_node.h | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

Comments

Hal Rosenstock Nov. 6, 2018, 1:51 p.m. UTC | #1

On 11/6/2018 8:28 AM, Honggang LI wrote:
> From: Honggang Li <[e-mail]>
> 
> Signed-off-by: Honggang Li <[e-mail]>

Thanks. Applied.

-- Hal

Patch

diff --git a/include/opensm/osm_node.h b/include/opensm/osm_node.h
index 1d349048..b6e5e00a 100644
--- a/include/opensm/osm_node.h
+++ b/include/opensm/osm_node.h
@@ -234,7 +234,7 @@  static inline osm_physp_t *osm_node_get_physp_ptr(IN osm_node_t * p_node,
 * RETURN VALUES
 *	Returns a pointer to the physical port object at the
 *	specified local port number.
-*	A return value of zero means the port number was out of range.
+*	A return value of NULL means the port number was out of range.
 *
 * NOTES
 *
@@ -454,6 +454,9 @@  void osm_node_init_physp(IN osm_node_t * p_node, uint8_t port_num,
 *	p_node
 *		[in] Pointer to an osm_node_t object.
 *
+*	port_num
+*		[in] Local port number.
+*
 *	p_madw
 *		[in] Pointer to a osm_madw_t object containing a mad with
 *		the node's NodeInfo attribute as discovered through the
@@ -517,7 +520,7 @@  void osm_node_link(IN osm_node_t * p_node, IN uint8_t port_num,
 *		[in] Port number in p_node through which to create the link.
 *
 *	p_remote_node
-*		[in] Pointer to the remote port object.
+*		[in] Pointer to the remote node object.
 *
 *	remote_port_num
 *		[in] Port number in the remote's node through which to
@@ -553,7 +556,7 @@  void osm_node_unlink(IN osm_node_t * p_node, IN uint8_t port_num,
 *		[in] Port number in p_node through which to unlink.
 *
 *	p_remote_node
-*		[in] Pointer to the remote port object.
+*		[in] Pointer to the remote node object.
 *
 *	remote_port_num
 *		[in] Port number in the remote's node through which to unlink.
@@ -590,7 +593,7 @@  boolean_t osm_node_link_exists(IN osm_node_t * p_node, IN uint8_t port_num,
 *		[in] Port number in p_node through which to check the link.
 *
 *	p_remote_node
-*		[in] Pointer to the remote port object.
+*		[in] Pointer to the remote node object.
 *
 *	remote_port_num
 *		[in] Port number in the remote's node through which to
@@ -660,6 +663,13 @@  boolean_t osm_node_link_has_valid_ports(IN osm_node_t * p_node,
 *	port_num
 *		[in] Port number in p_node through which to check the link.
 *
+*	p_remote_node
+*		[in] Pointer to the remote node object.
+*
+*	remote_port_num
+*		[in] Port number in the remote's node through which to
+*		check this link.
+*
 * RETURN VALUES
 *	Return TRUE if both ports in the link are valid (initialized).
 *	Returns FALSE otherwise.