Re: [PATCH] opensm/osm_node.h: Improve comments

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 11/5/2018 9:19 PM, Honggang LI wrote:
> From: Honggang Li <honli@xxxxxxxxxx>
> 
> Signed-off-by: Honggang Li <honli@xxxxxxxxxx>
> ---
>  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.
> 



[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Photo]     [Yosemite News]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]

  Powered by Linux