patch 'pcapng: document return values' has been queued to stable release 24.11.5

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 24.11.5

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 02/22/26. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/bluca/dpdk-stable

This queued commit can be viewed at:
https://github.com/bluca/dpdk-stable/commit/a2aa6f1907ffb37c8ee128081760316a83826711

Thanks.

Luca Boccassi

---
>From a2aa6f1907ffb37c8ee128081760316a83826711 Mon Sep 17 00:00:00 2001
From: Stephen Hemminger <stephen at networkplumber.org>
Date: Mon, 16 Feb 2026 13:37:59 -0800
Subject: [PATCH] pcapng: document return values

[ upstream commit bb7af6b4a8295f29fdafa670f6b511090e4e877b ]

Update the Doxygen comments for rte_pcapng_add_interface()
and rte_pcapng_write_stats() to document return values.

Return values management in this library is not as consistent
as other libraries like ethdev but fixing it would break
API and ABI compatibility.

Fixes: 8d23ce8f5ee9 ("pcapng: add new library for writing pcapng files")

Signed-off-by: Stephen Hemminger <stephen at networkplumber.org>
---
 lib/pcapng/rte_pcapng.h | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/lib/pcapng/rte_pcapng.h b/lib/pcapng/rte_pcapng.h
index 48f2b57564..f51efcc6b1 100644
--- a/lib/pcapng/rte_pcapng.h
+++ b/lib/pcapng/rte_pcapng.h
@@ -82,6 +82,9 @@ rte_pcapng_close(rte_pcapng_t *self);
  * Interfaces must be added to the output file after opening
  * and before any packet record. All ports used in packet capture
  * must be added.
+ *
+ * @return
+ *   number of bytes written to file, -1 on failure
  */
 int
 rte_pcapng_add_interface(rte_pcapng_t *self, uint16_t port,
@@ -121,7 +124,7 @@ enum rte_pcapng_direction {
  *
  * @return
  *   - The pointer to the new mbuf formatted for pcapng_write
- *   - NULL if allocation fails.
+ *   - NULL on error such as invalid port or out of memory.
  */
 struct rte_mbuf *
 rte_pcapng_copy(uint16_t port_id, uint32_t queue,
@@ -185,7 +188,9 @@ rte_pcapng_write_packets(rte_pcapng_t *self,
  * @param comment
  *  Optional comment to add to statistics.
  * @return
- *  number of bytes written to file, -1 on failure to write file
+ *  On success number of bytes written to file,
+ *   -1 on failure to write file (and errno is set)
+ *   - (-EINVAL) if bad parameter.
  */
 ssize_t
 rte_pcapng_write_stats(rte_pcapng_t *self, uint16_t port,
-- 
2.47.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2026-02-20 14:55:47.508115108 +0000
+++ 0113-pcapng-document-return-values.patch	2026-02-20 14:55:43.376193990 +0000
@@ -1 +1 @@
-From bb7af6b4a8295f29fdafa670f6b511090e4e877b Mon Sep 17 00:00:00 2001
+From a2aa6f1907ffb37c8ee128081760316a83826711 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit bb7af6b4a8295f29fdafa670f6b511090e4e877b ]
+
@@ -14 +15,0 @@
-Cc: stable at dpdk.org
@@ -22 +23 @@
-index de1bf953e9..8d0974c3fd 100644
+index 48f2b57564..f51efcc6b1 100644
@@ -25 +26 @@
-@@ -89,6 +89,9 @@ rte_pcapng_close(rte_pcapng_t *self);
+@@ -82,6 +82,9 @@ rte_pcapng_close(rte_pcapng_t *self);
@@ -34,2 +35,2 @@
- rte_pcapng_add_interface(rte_pcapng_t *self, uint16_t port, uint16_t link_type,
-@@ -128,7 +131,7 @@ enum rte_pcapng_direction {
+ rte_pcapng_add_interface(rte_pcapng_t *self, uint16_t port,
+@@ -121,7 +124,7 @@ enum rte_pcapng_direction {
@@ -44 +45 @@
-@@ -192,7 +195,9 @@ rte_pcapng_write_packets(rte_pcapng_t *self,
+@@ -185,7 +188,9 @@ rte_pcapng_write_packets(rte_pcapng_t *self,