]> git.droids-corp.org - dpdk.git/commit
lib: document free functions
authorStephen Hemminger <stephen@networkplumber.org>
Wed, 22 Jun 2022 20:52:57 +0000 (13:52 -0700)
committerDavid Marchand <david.marchand@redhat.com>
Fri, 24 Jun 2022 12:50:34 +0000 (14:50 +0200)
commit448e01f1b5848b20cb0300d339100dd82f4459e9
treea71e8dc0d2be3bdc12bfed2b6672e114efbceaf6
parentcb68a5634303caa6e0d5c40fc121f31fd08e76b6
lib: document free functions

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."

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
[David: squashed with other series updates, unified wording]
21 files changed:
lib/acl/rte_acl.h
lib/bitratestats/rte_bitrate.h
lib/compressdev/rte_comp.h
lib/cryptodev/rte_crypto.h
lib/eal/include/rte_interrupts.h
lib/efd/rte_efd.h
lib/eventdev/rte_event_ring.h
lib/fib/rte_fib.h
lib/fib/rte_fib6.h
lib/lpm/rte_lpm.h
lib/lpm/rte_lpm6.h
lib/member/rte_member.h
lib/pipeline/rte_port_in_action.h
lib/pipeline/rte_swx_ctl.h
lib/pipeline/rte_swx_pipeline.h
lib/reorder/rte_reorder.h
lib/rib/rte_rib.h
lib/rib/rte_rib6.h
lib/sched/rte_sched.h
lib/stack/rte_stack.h
lib/telemetry/rte_telemetry.h