From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 1EE33A0545;
	Thu, 23 Jun 2022 02:37:45 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id A53324069C;
	Thu, 23 Jun 2022 02:37:44 +0200 (CEST)
Received: from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187])
 by mails.dpdk.org (Postfix) with ESMTP id C5E36400D6
 for <dev@dpdk.org>; Thu, 23 Jun 2022 02:37:42 +0200 (CEST)
Received: from dggpeml500024.china.huawei.com (unknown [172.30.72.55])
 by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4LT1XB1xRRzkWjS;
 Thu, 23 Jun 2022 08:36:26 +0800 (CST)
Received: from [127.0.0.1] (10.67.100.224) by dggpeml500024.china.huawei.com
 (7.185.36.10) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.24; Thu, 23 Jun
 2022 08:37:39 +0800
Subject: Re: [PATCH v4] lib: document existing free functions
To: Stephen Hemminger <stephen@networkplumber.org>, <dev@dpdk.org>
CC: Fan Zhang <roy.fan.zhang@intel.com>, Ashish Gupta
 <ashish.gupta@marvell.com>, Akhil Goyal <gakhil@marvell.com>, Harman Kalra
 <hkalra@marvell.com>, Byron Marohn <byron.marohn@intel.com>, Yipeng Wang
 <yipeng1.wang@intel.com>, Jerin Jacob <jerinj@marvell.com>, Vladimir
 Medvedkin <vladimir.medvedkin@intel.com>, Sameh Gobriel
 <sameh.gobriel@intel.com>, Reshma Pattan <reshma.pattan@intel.com>, Cristian
 Dumitrescu <cristian.dumitrescu@intel.com>, Jasvinder Singh
 <jasvinder.singh@intel.com>, Olivier Matz <olivier.matz@6wind.com>, Ciara
 Power <ciara.power@intel.com>
References: <20220220182147.9750-1-stephen@networkplumber.org>
 <20220622205257.404945-1-stephen@networkplumber.org>
From: fengchengwen <fengchengwen@huawei.com>
Message-ID: <4447a124-5a09-5a1f-02d3-f8f7f03f4402@huawei.com>
Date: Thu, 23 Jun 2022 08:37:39 +0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101
 Thunderbird/68.11.0
MIME-Version: 1.0
In-Reply-To: <20220622205257.404945-1-stephen@networkplumber.org>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-Originating-IP: [10.67.100.224]
X-ClientProxiedBy: dggems702-chm.china.huawei.com (10.3.19.179) To
 dggpeml500024.china.huawei.com (7.185.36.10)
X-CFilter-Loop: Reflected
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

On 2022/6/23 4:52, Stephen Hemminger wrote:
> Make sure all functions which use the convention that XXX_free(NULL)
> is a nop are all documented.
> 
> The wording is chosen to match the documentation of free(3).
> "If ptr is NULL, no operation is performed."

It's a good idea to add such explicit description.

Acked-by: Chengwen Feng <fengchengwen@huawei.com>

> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  lib/bitratestats/rte_bitrate.h   | 1 +
>  lib/compressdev/rte_comp.h       | 3 ++-
>  lib/cryptodev/rte_crypto.h       | 4 +++-
>  lib/eal/include/rte_interrupts.h | 3 ++-
>  lib/efd/rte_efd.h                | 3 ++-
>  lib/eventdev/rte_event_ring.h    | 3 ++-
>  lib/fib/rte_fib.h                | 3 ++-
>  lib/fib/rte_fib6.h               | 3 ++-
>  lib/member/rte_member.h          | 1 +
>  lib/reorder/rte_reorder.h        | 3 ++-
>  lib/rib/rte_rib.h                | 3 ++-
>  lib/rib/rte_rib6.h               | 3 ++-
>  lib/sched/rte_sched.h            | 3 ++-
>  lib/stack/rte_stack.h            | 3 ++-
>  lib/telemetry/rte_telemetry.h    | 2 +-
>  15 files changed, 28 insertions(+), 13 deletions(-)
> 

...