From: Dean Marx <dmarx@iol.unh.edu>
To: probb@iol.unh.edu, luca.vizzarro@arm.com,
yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com,
paul.szczepanek@arm.com
Cc: dev@dpdk.org, Dean Marx <dmarx@iol.unh.edu>
Subject: [PATCH v1] dts: update dts.rst with current API status
Date: Fri, 14 Nov 2025 13:59:44 -0500 [thread overview]
Message-ID: <20251114185944.337957-1-dmarx@iol.unh.edu> (raw)
Rewrite the section of dts.rst outlining use of the DTS
framework in writing test suites to properly reflect
the current state of the DTS API and how to use it.
Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
---
doc/guides/tools/dts.rst | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index f0abfdcb7a..195e8f752a 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -503,20 +503,19 @@ Leveraging the DTS framework in writing testsuites
One should avoid directly importing DTS framework code to their testsuites where possible.
Instead, for performing common processes required in testsuites,
-one should use (or add to) the list of methods provided in the ``Testsuite`` class
-(the base class of all testsuites).
+one should use (or add to) the list of methods provided in the ``api`` module.
For instance, for sending a list of packets,
one should work through the packet transmitting function
-already made available in the ``TestSuite`` class,
+already made available in the ``api`` module,
instead of directly importing the DTS traffic generator class
and using that class in one's testsuite implementation.
It is also acceptable to import and instantiate classes for various DPDK applications.
For instance, writing a testsuite for a simple packet forwarding operation
-would involve importing the DTS ``TestPmd`` class,
+would involve importing the DTS ``TestPmd`` class from the ``api`` module,
instantiating ``TestPmd``, calling ``TestPmd``'s ``start()`` method,
and then sending traffic via one of the traffic transmitting functions
-exposed in the ``Testsuite`` class.
+exposed in the ``api`` module.
Test Case Verification
~~~~~~~~~~~~~~~~~~~~~~
--
2.51.0
next reply other threads:[~2025-11-14 18:59 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-14 18:59 Dean Marx [this message]
2025-11-14 20:43 ` Patrick Robb
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251114185944.337957-1-dmarx@iol.unh.edu \
--to=dmarx@iol.unh.edu \
--cc=Honnappa.Nagarahalli@arm.com \
--cc=dev@dpdk.org \
--cc=luca.vizzarro@arm.com \
--cc=paul.szczepanek@arm.com \
--cc=probb@iol.unh.edu \
--cc=yoan.picchi@foss.arm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).