DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH] doc: elaborate on per test suite configuration dts docs
@ 2025-05-16 20:26 Nicholas Pratte
  0 siblings, 0 replies; only message in thread
From: Nicholas Pratte @ 2025-05-16 20:26 UTC (permalink / raw)
  To: luca.vizzarro, thomas, probb, dmarx, paul.szczepanek,
	Honnappa.Nagarahalli, thomas.wilks, yoan.picchi, stephen
  Cc: dev, Nicholas Pratte

Introduce some additional documentation explaing the per test suite
configuration component of DTS as the current dts documentation does
not provide a quick access reference guide or explanation.

Signed-off-by: Nicholas Pratte <npratte@iol.unh.edu>
---
 doc/guides/tools/dts.rst | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index fcc6d22036..951b5462e2 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -405,6 +405,13 @@ There are four types of methods that comprise a test suite:
    If there's any functionality or logic missing from the framework,
    it should be implemented so that the test suites can use one of these two ways.
 
+   Test suites may also be configured individually using a provided configuration file,
+   provided at the command line, for custom configuration. The configuration file is a simple
+   mapping of test suite names to their corresponding configurations.
+
+   Any test suite can be designed to require custom configuration attributes or optional ones.
+   Any optional attributes should supply a default value for the test suite to use.
+
 #. **Test case verification**
 
    Test case verification should be done with the ``verify`` method, which records the result.
@@ -507,3 +514,18 @@ And they both have two network ports which are physically connected to each othe
 .. literalinclude:: ../../../dts/nodes.example.yaml
    :language: yaml
    :start-at: # Define
+
+Additionally, an example configuration file is provided to demonstrate custom test suite configuration:
+
+.. note::
+   You do not neeed to supply configurations for all test suites, and not all test suites will support
+   or need additional configuration.
+
+.. _tests_config_example:
+
+``dts/tests_config.example.yaml``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. literalinclude:: ../../../dts/tests_config.example.yaml
+   :language: yaml
+   :start-at: # Define
\ No newline at end of file
-- 
2.47.1


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2025-05-16 20:26 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-05-16 20:26 [PATCH] doc: elaborate on per test suite configuration dts docs Nicholas Pratte

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).