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 <dm...@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
