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 v3 2/3] doc: rephrase terminology in dts.rst
Date: Fri, 11 Jul 2025 13:24:54 -0400 [thread overview]
Message-ID: <20250711172534.540416-2-dmarx@iol.unh.edu> (raw)
In-Reply-To: <20250711172534.540416-1-dmarx@iol.unh.edu>
Rephrase some of the DTS tool/term definitions to be more concise.
These sections were unnecessarily verbose and can be conveyed
in a clearer way.
Signed-off-by: Dean Marx <dmarx@iol.unh.edu>
---
doc/guides/tools/dts.rst | 37 ++++++++++++-------------------------
1 file changed, 12 insertions(+), 25 deletions(-)
diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 016dc5e374..7f6f7c1db5 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -1,6 +1,7 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2022-2023 PANTHEON.tech s.r.o.
Copyright(c) 2024 Arm Limited
+ Copyright(c) 2025 University of New Hampshire
DPDK Test Suite
===============
@@ -20,31 +21,22 @@ DTS runtime environment
DTS runtime environment node
A node where at least one DTS runtime environment is present.
- This is the node where we run DTS and from which DTS connects to other nodes.
+ This is the node where we run DTS and from which DTS connects to other
+ nodes.
System under test
- An SUT is the combination of DPDK and the hardware we're testing
- in conjunction with DPDK (NICs, crypto and other devices).
+ The system which runs a DPDK application on relevant
+ hardware (NIC, accelerator cards, etc) and from which the DPDK behavior is
+ observed for tests.
System under test node
A node where at least one SUT is present.
Traffic generator
- A TG is either software or hardware capable of sending packets.
+ Node that sends traffic to the SUT; can be hardware or software-based.
Traffic generator node
A node where at least one TG is present.
- In case of hardware traffic generators, the TG and the node are literally the same.
-
-
-In most cases, interchangeably referring to a runtime environment, SUT, TG or the node
-they're running on (e.g. using SUT and SUT node interchangeably) doesn't cause confusion.
-There could theoretically be more than of these running on the same node and in that case
-it's useful to have stricter definitions.
-An example would be two different traffic generators (such as Trex and Scapy)
-running on the same node.
-A different example would be a node containing both a DTS runtime environment
-and a traffic generator, in which case it's both a DTS runtime environment node and a TG node.
DTS Environment
@@ -481,17 +473,12 @@ DTS Developer Tools
There are two tools used in DTS to help with code checking, style and formatting:
-* `ruff <https://astral.sh/ruff/>`_
-
- An extremely fast all-in-one linting and formatting solution,
- which covers most if not all the major rules such as:
- pylama, flake8, pylint etc.
- Its built-in formatter is also Black-compatible
- and is able to sort imports automatically like isort would.
-
-* `mypy <https://github.com/python/mypy>`_
+ruff:
+ - Linter and formatter (replaces flake8, pylint, isort, etc.)
+ - Compatible with Black
- Enables static typing for Python, exploiting the type hints in the source code.
+mypy:
+ - Performs static type checking
These two tools are all used in ``devtools/dts-check-format.sh``,
the DTS code check and format script.
--
2.49.0
next prev parent reply other threads:[~2025-07-11 17:25 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-27 15:37 [PATCH v1 1/3] dts: rewrite README Dean Marx
2025-05-27 15:37 ` [PATCH v1 2/3] dts: rewrite dts rst Dean Marx
2025-05-28 21:25 ` Patrick Robb
2025-05-29 12:27 ` Paul Szczepanek
2025-06-03 17:28 ` [PATCH v2 1/2] dts: rewrite README Dean Marx
2025-06-03 17:28 ` [PATCH v2 2/2] dts: rewrite dts rst Dean Marx
2025-06-25 4:07 ` Patrick Robb
2025-07-09 19:57 ` Thomas Monjalon
2025-07-11 14:58 ` Patrick Robb
2025-06-25 4:06 ` [PATCH v2 1/2] dts: rewrite README Patrick Robb
2025-07-11 17:24 ` [PATCH v3 1/3] " Dean Marx
2025-07-11 17:24 ` Dean Marx [this message]
2025-07-11 17:24 ` [PATCH v3 3/3] doc: revise coding guidelines section Dean Marx
2025-07-11 21:22 ` [PATCH v3 1/3] dts: rewrite README Patrick Robb
2025-05-27 15:37 ` [PATCH v1 3/3] dts: fix doc generation bug Dean Marx
2025-05-28 20:28 ` Patrick Robb
2025-05-29 12:28 ` Paul Szczepanek
2025-05-28 20:40 ` [PATCH v1 1/3] dts: rewrite README Patrick Robb
2025-05-29 12:27 ` Paul Szczepanek
2025-05-29 12:40 ` Paul Szczepanek
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=20250711172534.540416-2-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).