From patchwork Tue Nov 6 02:42:27 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honggang LI X-Patchwork-Id: 10669525 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 A9C0D14BD for ; Tue, 6 Nov 2018 02:42:34 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 95A3F2A0C0 for ; Tue, 6 Nov 2018 02:42:34 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 82EAA2A0D7; Tue, 6 Nov 2018 02:42:34 +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.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI,SUBJ_OBFU_PUNCT_FEW 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 424212A0C0 for ; Tue, 6 Nov 2018 02:42:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727358AbeKFMFY (ORCPT ); Tue, 6 Nov 2018 07:05:24 -0500 Received: from mx1.redhat.com ([209.132.183.28]:42006 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726389AbeKFMFY (ORCPT ); Tue, 6 Nov 2018 07:05:24 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 2B5B583F4C; Tue, 6 Nov 2018 02:42:32 +0000 (UTC) Received: from lhg.nay.redhat.com (unknown [10.66.129.124]) by smtp.corp.redhat.com (Postfix) with ESMTP id BA3605D962; Tue, 6 Nov 2018 02:42:30 +0000 (UTC) From: Honggang LI To: hal@dev.mellanox.co.il Cc: linux-rdma@vger.kernel.org, Honggang Li Subject: [PATCH] opensm/osm_router.h: Improve comments Date: Tue, 6 Nov 2018 10:42:27 +0800 Message-Id: <20181106024227.18607-1-honli@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Tue, 06 Nov 2018 02:42:32 +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_router.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/opensm/osm_router.h b/include/opensm/osm_router.h index b5512210..11e34b64 100644 --- a/include/opensm/osm_router.h +++ b/include/opensm/osm_router.h @@ -120,7 +120,8 @@ void osm_router_delete(IN OUT osm_router_t ** pp_rtr); /* * PARAMETERS * p_rtr -* [in] Pointer to the object to destroy. +* [in][out] Pointer to a pointer to the object to destroy. +* The pointer will be set to NULL on return. * * RETURN VALUE * None.