From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id BBCF4A00C2; Sun, 20 Feb 2022 01:52:07 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 16D6441157; Sun, 20 Feb 2022 01:51:53 +0100 (CET) Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by mails.dpdk.org (Postfix) with ESMTP id 771FD41147 for ; Sun, 20 Feb 2022 01:51:49 +0100 (CET) Received: by mail-pl1-f172.google.com with SMTP id z2so1403053plg.8 for ; Sat, 19 Feb 2022 16:51:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=bWbhdn5YZ1cHnXbTN7Kx9VJoW39NJkYUfErisW629FY=; b=EG2U2HSrSDq57gs+w/A5w6U6qa7ZqNSlhJqvQOBSt4ByEzSkZR9hQBwg7nD4S0xnHl xKh9ftuPfllVYQjMMC7nKpRR+exxcQnMN/6pcyCJObbCvEvw/YQOqzVby6Lz8twyUdNh 3hxYp94Ksc3XaSEAx4r5xW8JL3DUib9oA1Nn+aKgflJhwCLkFERz43p1L1YJQ75QzsPc PSi6vuhfGgquUOUXefTJRPLACvTGkgTzbOdQ5SLUPeAwM4XVwcDo0Yksz0v4NU1g5aUF IhpsA+H2K9KoKK3dvSwpFnNLhHVZCWkEds2ovaqWe1gIKUVYwBiPaMkwa+WOx1wUz8Mh ftlA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=bWbhdn5YZ1cHnXbTN7Kx9VJoW39NJkYUfErisW629FY=; b=HN5pWpUwDT+y4Zbnt/eF3rJo9tKWi75sBAQ706VH1zleEkiblOAZxGqbmeU4lcLtor NdwXVKc5OB8S+h3y5C7JcPg++Z/b+o+313UjiR9goICrxcfhpXdSGA3PCSysr+leFl1I XT3O6R7MaQ+GcrMTUptHriC7hrOP+/xtODkDhNs79xSp8wm92vnnn4bqG/pJ2AygGHZm 15NhYsyZWJLAbPE5kFbTB0M0zbqQ/N2gnNqGW2pjarWbrPVu/Lg+EOlWcdga9jebeUeR 50T30uG+WntLPa6bOyx//ZvLkhXIVXxq21UKNQqBOcen8wK6v3KF/DirFm4PJhQyvYR5 HLzw== X-Gm-Message-State: AOAM530Hps++LmU2gpsrSOKC09TXuCvnPRbCL5anDKgmuYFDYsrCjf4f Y14iT1NIQ8ZGLXPYqXJAe/zynifJp5MwDtUJ X-Google-Smtp-Source: ABdhPJzyq/2Kd0cnPcsGFply0ZI+j2bRsZXWST6gFN4EEyU7gWen4Cx+gnF8ADiuLWokkPNmEv/V5A== X-Received: by 2002:a17:90a:db92:b0:1bc:1670:2aff with SMTP id h18-20020a17090adb9200b001bc16702affmr2379536pjv.8.1645318308345; Sat, 19 Feb 2022 16:51:48 -0800 (PST) Received: from hermes.local (204-195-112-199.wavecable.com. [204.195.112.199]) by smtp.gmail.com with ESMTPSA id f7sm8129695pfc.0.2022.02.19.16.51.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Feb 2022 16:51:47 -0800 (PST) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Fan Zhang , Ashish Gupta , Akhil Goyal , Harman Kalra , Byron Marohn , Yipeng Wang , Jerin Jacob , Sameh Gobriel , Vladimir Medvedkin , Olivier Matz , Ciara Power Subject: [PATCH v2 4/7] lib: document existing free functions Date: Sat, 19 Feb 2022 16:51:37 -0800 Message-Id: <20220220005140.78713-5-stephen@networkplumber.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220220005140.78713-1-stephen@networkplumber.org> References: <20220219234322.61309-1-stephen@networkplumber.org> <20220220005140.78713-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org These functions all accept NULL as parameter. Signed-off-by: Stephen Hemminger --- lib/compressdev/rte_comp.h | 1 + lib/cryptodev/rte_crypto.h | 1 + lib/eal/include/rte_interrupts.h | 4 +++- lib/efd/rte_efd.h | 1 + lib/eventdev/rte_event_ring.h | 1 + lib/member/rte_member.h | 1 + lib/rib/rte_rib.h | 1 + lib/rib/rte_rib6.h | 1 + lib/stack/rte_stack.h | 1 + lib/telemetry/rte_telemetry.h | 2 +- 10 files changed, 12 insertions(+), 2 deletions(-) diff --git a/lib/compressdev/rte_comp.h b/lib/compressdev/rte_comp.h index 95306c5d0364..b07434ad39b2 100644 --- a/lib/compressdev/rte_comp.h +++ b/lib/compressdev/rte_comp.h @@ -471,6 +471,7 @@ rte_comp_op_bulk_alloc(struct rte_mempool *mempool, * * @param op * Compress operation + * If NULL then, the function does nothing. */ __rte_experimental void diff --git a/lib/cryptodev/rte_crypto.h b/lib/cryptodev/rte_crypto.h index a864f5036f3a..326764b0f0c0 100644 --- a/lib/cryptodev/rte_crypto.h +++ b/lib/cryptodev/rte_crypto.h @@ -339,6 +339,7 @@ __rte_crypto_op_get_priv_data(struct rte_crypto_op *op, uint32_t size) * be returned to the mempool. * * @param op symmetric crypto operation + * If NULL then, the function does nothing. */ static inline void rte_crypto_op_free(struct rte_crypto_op *op) diff --git a/lib/eal/include/rte_interrupts.h b/lib/eal/include/rte_interrupts.h index edbf0faeeffd..3ef8ab4621fb 100644 --- a/lib/eal/include/rte_interrupts.h +++ b/lib/eal/include/rte_interrupts.h @@ -243,7 +243,8 @@ rte_intr_instance_alloc(uint32_t flags); * resources. * * @param intr_handle - * Interrupt handle address. + * Interrupt handle address. + * If NULL then, the function does nothing. * */ __rte_experimental @@ -746,6 +747,7 @@ rte_intr_vec_list_index_get(const struct rte_intr_handle *intr_handle, * * @param intr_handle * pointer to the interrupt handle. + * If NULL then, the function does nothing. * * @return * - On success, zero diff --git a/lib/efd/rte_efd.h b/lib/efd/rte_efd.h index d3d7befd0c90..afba38a78c8a 100644 --- a/lib/efd/rte_efd.h +++ b/lib/efd/rte_efd.h @@ -146,6 +146,7 @@ rte_efd_create(const char *name, uint32_t max_num_rules, uint32_t key_len, * * @param table * Table to free + * If NULL then, the function does nothing. */ void rte_efd_free(struct rte_efd_table *table); diff --git a/lib/eventdev/rte_event_ring.h b/lib/eventdev/rte_event_ring.h index c0861b0ec2db..85c214a678cd 100644 --- a/lib/eventdev/rte_event_ring.h +++ b/lib/eventdev/rte_event_ring.h @@ -233,6 +233,7 @@ rte_event_ring_lookup(const char *name); * * @param r * Ring to free + * If NULL then, the function does nothing. */ void rte_event_ring_free(struct rte_event_ring *r); diff --git a/lib/member/rte_member.h b/lib/member/rte_member.h index c0689e233e65..ada3b96e5ec1 100644 --- a/lib/member/rte_member.h +++ b/lib/member/rte_member.h @@ -444,6 +444,7 @@ rte_member_add(const struct rte_member_setsum *setsum, const void *key, * * @param setsum * Pointer to the set summary. + * If NULL then, the function does nothing. */ void rte_member_free(struct rte_member_setsum *setsum); diff --git a/lib/rib/rte_rib.h b/lib/rib/rte_rib.h index bebb30f7d7cf..bafd2585ac69 100644 --- a/lib/rib/rte_rib.h +++ b/lib/rib/rte_rib.h @@ -265,6 +265,7 @@ rte_rib_find_existing(const char *name); * * @param rib * RIB object handle + * If NULL then, the function does nothing. * @return * None */ diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h index 6f532265c657..a2e179ccb4b9 100644 --- a/lib/rib/rte_rib6.h +++ b/lib/rib/rte_rib6.h @@ -320,6 +320,7 @@ rte_rib6_find_existing(const char *name); * * @param rib * RIB object handle + * If NULL then, the function does nothing. * @return * None */ diff --git a/lib/stack/rte_stack.h b/lib/stack/rte_stack.h index 321f4cec1a10..8c3bd4862711 100644 --- a/lib/stack/rte_stack.h +++ b/lib/stack/rte_stack.h @@ -215,6 +215,7 @@ rte_stack_create(const char *name, unsigned int count, int socket_id, * * @param s * Stack to free + * If NULL then, the function does nothing. */ void rte_stack_free(struct rte_stack *s); diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h index 7bca8a9a49e2..af95fb4f150b 100644 --- a/lib/telemetry/rte_telemetry.h +++ b/lib/telemetry/rte_telemetry.h @@ -289,7 +289,7 @@ rte_tel_data_alloc(void); * * @param data * Pointer to container. - *. + * If NULL then, the function does nothing. */ void rte_tel_data_free(struct rte_tel_data *data); -- 2.34.1