diff mbox series

[opensm,2/6] opensm/osm_mtree.h: Improve comments

Message ID 20181107142246.28336-2-honli@redhat.com (mailing list archive)
State Not Applicable
Headers show
Series [opensm,1/6] opensm/osm_vl15intf.h: Minor update of comments | expand

Commit Message

Honggang LI Nov. 7, 2018, 2:22 p.m. UTC 
From: Honggang Li <honli@redhat.com>

Signed-off-by: Honggang Li <honli@redhat.com>
---
 include/opensm/osm_mtree.h | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/include/opensm/osm_mtree.h b/include/opensm/osm_mtree.h
index 32f51790..b8307f0c 100644
--- a/include/opensm/osm_mtree.h
+++ b/include/opensm/osm_mtree.h
@@ -124,6 +124,7 @@  typedef struct osm_mtree_node {
 *	child_array
 *		Array (indexed by port number) of pointers to the
 *		child osm_mtree_node_t objects of this tree node, if any.
+*		MUST BE LAST ELEMENT!!!
 *
 * SEE ALSO
 *********/
@@ -258,9 +259,6 @@  static inline const osm_switch_t *osm_mtree_node_get_switch_ptr(IN const
 *	p_mtn
 *		[in] Pointer to the multicast tree node.
 *
-*	child
-*		[in] Index of the child to retrieve.
-*
 * RETURN VALUES
 *	Returns a pointer to the switch object represented by this tree node.
 *