DPDK patches and discussions
 help / color / mirror / Atom feed
From: Nicholas Pratte <npratte@iol.unh.edu>
To: luca.vizzarro@arm.com, thomas@monjalon.net, probb@iol.unh.edu,
	dmarx@iol.unh.edu, paul.szczepanek@arm.com,
	Honnappa.Nagarahalli@arm.com, thomas.wilks@arm.com,
	yoan.picchi@foss.arm.com, stephen@networkplumber.org
Cc: dev@dpdk.org, Nicholas Pratte <npratte@iol.unh.edu>
Subject: [PATCH] doc: elaborate on per test suite configuration dts docs
Date: Fri, 16 May 2025 16:26:01 -0400	[thread overview]
Message-ID: <20250516202600.632070-2-npratte@iol.unh.edu> (raw)

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


                 reply	other threads:[~2025-05-16 20:26 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20250516202600.632070-2-npratte@iol.unh.edu \
    --to=npratte@iol.unh.edu \
    --cc=Honnappa.Nagarahalli@arm.com \
    --cc=dev@dpdk.org \
    --cc=dmarx@iol.unh.edu \
    --cc=luca.vizzarro@arm.com \
    --cc=paul.szczepanek@arm.com \
    --cc=probb@iol.unh.edu \
    --cc=stephen@networkplumber.org \
    --cc=thomas.wilks@arm.com \
    --cc=thomas@monjalon.net \
    --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).