| Message ID | 20181106021936.18042-1-honli@redhat.com (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | opensm/osm_node.h: Improve comments | expand |
On 11/5/2018 9:19 PM, Honggang LI wrote: > From: Honggang Li <honli@redhat.com> > > Signed-off-by: Honggang Li <honli@redhat.com> > --- > include/opensm/osm_node.h | 12 +++++++++++- > 1 file changed, 11 insertions(+), 1 deletion(-) > > diff --git a/include/opensm/osm_node.h b/include/opensm/osm_node.h > index 1d349048..feae9909 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 > @@ -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 port object. Shouldn't this be 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. >
On Tue, Nov 06, 2018 at 07:31:02AM -0500, Hal Rosenstock wrote: > On 11/5/2018 9:19 PM, Honggang LI wrote: > > From: Honggang Li <honli@redhat.com> > > > > Signed-off-by: Honggang Li <honli@redhat.com> > > --- > > include/opensm/osm_node.h | 12 +++++++++++- > > 1 file changed, 11 insertions(+), 1 deletion(-) > > > > diff --git a/include/opensm/osm_node.h b/include/opensm/osm_node.h > > index 1d349048..feae9909 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 > > @@ -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 port object. > > Shouldn't this be remote node object ? please drop this patch. I will send a new patch shortly. > > > +* > > +* 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. > >
diff --git a/include/opensm/osm_node.h b/include/opensm/osm_node.h index 1d349048..feae9909 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 @@ -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 port 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.