patch 'dts: fix deterministic doc' has been queued to stable release 23.11.5

[Xueming Li]

Hi,

FYI, your patch has been queued to stable release 23.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 08/10/25. 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://git.dpdk.org/dpdk-stable/log/?h=23.11-staging

This queued commit can be viewed at:
https://git.dpdk.org/dpdk-stable/commit/?h=23.11-staging&id=f5520b77b358f6ab072762779cd170a0386549a7

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From f5520b77b358f6ab072762779cd170a0386549a7 Mon Sep 17 00:00:00 2001
From: Clemens Famulla-Conrad <cfamullaconrad at suse.com>
Date: Wed, 11 Jun 2025 16:05:30 +0200
Subject: [PATCH] dts: fix deterministic doc
Cc: Xueming Li <xuemingl at nvidia.com>

[ upstream commit 5603ab87f2ed666c59cdb3ef7a210c68f3af1f2d ]

Previously, `capture_name` defaulted to a "dynamic" value.
This caused non-deterministic documentation and could lead
to overwriting capture files if the method was called
multiple times within a single Python process.

Bugzilla ID: 1718
Fixes: cecfe0aabf58 ("dts: add traffic generator abstractions")

Signed-off-by: Clemens Famulla-Conrad <cfamullaconrad at suse.com>
Reviewed-by: Luca Vizzarro <luca.vizzarro at arm.com>
---
 .mailmap                                                   | 1 +
 dts/framework/testbed_model/capturing_traffic_generator.py | 5 ++++-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/.mailmap b/.mailmap
index 889fd604fe..ddf58a13f4 100644
--- a/.mailmap
+++ b/.mailmap
@@ -257,6 +257,7 @@ Cian Ferriter <cian.ferriter at intel.com>
 Ciara Loftus <ciara.loftus at intel.com>
 Ciara Power <ciara.power at intel.com>
 Claire Murphy <claire.k.murphy at intel.com>
+Clemens Famulla-Conrad <cfamullaconrad at suse.com>
 Cody Doucette <doucette at bu.edu>
 Congwen Zhang <zhang.congwen at zte.com.cn>
 Conor Fogarty <conor.fogarty at intel.com>
diff --git a/dts/framework/testbed_model/capturing_traffic_generator.py b/dts/framework/testbed_model/capturing_traffic_generator.py
index e6512061d7..2e34cfb464 100644
--- a/dts/framework/testbed_model/capturing_traffic_generator.py
+++ b/dts/framework/testbed_model/capturing_traffic_generator.py
@@ -80,7 +80,7 @@ class CapturingTrafficGenerator(TrafficGenerator):
         send_port: Port,
         receive_port: Port,
         duration: float,
-        capture_name: str = _get_default_capture_name(),
+        capture_name: str = "",
     ) -> list[Packet]:
         """Send packets, return received traffic.
 
@@ -109,6 +109,9 @@ class CapturingTrafficGenerator(TrafficGenerator):
             duration,
         )
 
+        if not capture_name:
+            capture_name = _get_default_capture_name()
+
         self._logger.debug(f"Received packets: {get_packet_summaries(received_packets)}")
         self._write_capture_from_packets(capture_name, received_packets)
         return received_packets
-- 
2.34.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2025-07-30 15:02:13.670682378 +0800
+++ 0031-dts-fix-deterministic-doc.patch	2025-07-30 15:02:12.845770859 +0800
@@ -1 +1 @@
-From 5603ab87f2ed666c59cdb3ef7a210c68f3af1f2d Mon Sep 17 00:00:00 2001
+From f5520b77b358f6ab072762779cd170a0386549a7 Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit 5603ab87f2ed666c59cdb3ef7a210c68f3af1f2d ]
@@ -13 +15,0 @@
-Cc: stable at dpdk.org
@@ -18,2 +20,2 @@
- .mailmap                                                     | 1 +
- .../traffic_generator/capturing_traffic_generator.py         | 5 ++++-
+ .mailmap                                                   | 1 +
+ dts/framework/testbed_model/capturing_traffic_generator.py | 5 ++++-
@@ -23 +25 @@
-index eba7383c7d..c7d55c7386 100644
+index 889fd604fe..ddf58a13f4 100644
@@ -26 +28 @@
-@@ -276,6 +276,7 @@ Cian Ferriter <cian.ferriter at intel.com>
+@@ -257,6 +257,7 @@ Cian Ferriter <cian.ferriter at intel.com>
@@ -34,5 +36,6 @@
-diff --git a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py
-index 61e5033f0b..a85858ba07 100644
---- a/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py
-+++ b/dts/framework/testbed_model/traffic_generator/capturing_traffic_generator.py
-@@ -72,7 +72,7 @@ class CapturingTrafficGenerator(TrafficGenerator):
+diff --git a/dts/framework/testbed_model/capturing_traffic_generator.py b/dts/framework/testbed_model/capturing_traffic_generator.py
+index e6512061d7..2e34cfb464 100644
+--- a/dts/framework/testbed_model/capturing_traffic_generator.py
++++ b/dts/framework/testbed_model/capturing_traffic_generator.py
+@@ -80,7 +80,7 @@ class CapturingTrafficGenerator(TrafficGenerator):
+         send_port: Port,
@@ -40 +42,0 @@
-         filter_config: PacketFilteringConfig,
@@ -45 +47 @@
-         """Send `packets` and capture received traffic.
+         """Send packets, return received traffic.
@@ -47 +49 @@
-@@ -106,6 +106,9 @@ class CapturingTrafficGenerator(TrafficGenerator):
+@@ -109,6 +109,9 @@ class CapturingTrafficGenerator(TrafficGenerator):