From patchwork Wed Nov 7 14:22:42 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honggang LI X-Patchwork-Id: 10672437 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 0DCDA14D6 for ; Wed, 7 Nov 2018 14:23:15 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F2A072C118 for ; Wed, 7 Nov 2018 14:23:14 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E79BD2C141; Wed, 7 Nov 2018 14:23:14 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A664E2C12A for ; Wed, 7 Nov 2018 14:23:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726830AbeKGXxs (ORCPT ); Wed, 7 Nov 2018 18:53:48 -0500 Received: from mx1.redhat.com ([209.132.183.28]:46904 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726688AbeKGXxs (ORCPT ); Wed, 7 Nov 2018 18:53:48 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 9F9E7C0587D2; Wed, 7 Nov 2018 14:23:13 +0000 (UTC) Received: from lhg.nay.redhat.com (unknown [10.66.129.124]) by smtp.corp.redhat.com (Postfix) with ESMTP id 393D560477; Wed, 7 Nov 2018 14:23:11 +0000 (UTC) From: Honggang LI To: hal@dev.mellanox.co.il Cc: linux-rdma@vger.kernel.org, Honggang Li Subject: [opensm patch 2/6] opensm/osm_mtree.h: Improve comments Date: Wed, 7 Nov 2018 22:22:42 +0800 Message-Id: <20181107142246.28336-2-honli@redhat.com> In-Reply-To: <20181107142246.28336-1-honli@redhat.com> References: <20181107142246.28336-1-honli@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Wed, 07 Nov 2018 14:23:13 +0000 (UTC) Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Honggang Li Signed-off-by: Honggang Li --- include/opensm/osm_mtree.h | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) 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. *