[PATCH v4] lib: document existing free functions

[fengchengwen]

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 at huawei.com>

> 
> Signed-off-by: Stephen Hemminger <stephen at 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(-)
> 

...