DPDK patches and discussions
 help / color / mirror / Atom feed
From: Luca Vizzarro <luca.vizzarro@arm.com>
To: dev@dpdk.org
Cc: Paul Szczepanek <paul.szczepanek@arm.com>,
	Patrick Robb <probb@iol.unh.edu>,
	Luca Vizzarro <luca.vizzarro@arm.com>
Subject: [PATCH v3 1/4] dts: add tests package to API docs
Date: Fri,  8 Nov 2024 13:45:29 +0000	[thread overview]
Message-ID: <20241108134532.130681-2-luca.vizzarro@arm.com> (raw)
In-Reply-To: <20241108134532.130681-1-luca.vizzarro@arm.com>

The test suites are not documented in the API as their respective
documentation files are missing.

Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
---
 doc/api/dts/index.rst                         |  1 +
 doc/api/dts/tests.TestSuite_hello_world.rst   |  9 +++++++++
 doc/api/dts/tests.TestSuite_os_udp.rst        |  9 +++++++++
 .../tests.TestSuite_pmd_buffer_scatter.rst    |  9 +++++++++
 doc/api/dts/tests.TestSuite_smoke_tests.rst   |  9 +++++++++
 doc/api/dts/tests.TestSuite_vlan.rst          | 10 ++++++++++
 doc/api/dts/tests.rst                         | 19 +++++++++++++++++++
 7 files changed, 66 insertions(+)
 create mode 100644 doc/api/dts/tests.TestSuite_hello_world.rst
 create mode 100644 doc/api/dts/tests.TestSuite_os_udp.rst
 create mode 100644 doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
 create mode 100644 doc/api/dts/tests.TestSuite_smoke_tests.rst
 create mode 100644 doc/api/dts/tests.TestSuite_vlan.rst
 create mode 100644 doc/api/dts/tests.rst

diff --git a/doc/api/dts/index.rst b/doc/api/dts/index.rst
index 534512dc17..db05fd37d5 100644
--- a/doc/api/dts/index.rst
+++ b/doc/api/dts/index.rst
@@ -14,6 +14,7 @@ Packages
    :includehidden:
    :maxdepth: 1
 
+   tests
    framework.testbed_model
    framework.remote_session
    framework.params
diff --git a/doc/api/dts/tests.TestSuite_hello_world.rst b/doc/api/dts/tests.TestSuite_hello_world.rst
new file mode 100644
index 0000000000..f92786996f
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_hello_world.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+hello_world Test Suite
+======================
+
+.. automodule:: tests.TestSuite_hello_world
+   :members:
+   :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_os_udp.rst b/doc/api/dts/tests.TestSuite_os_udp.rst
new file mode 100644
index 0000000000..121a653670
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_os_udp.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+os_udp Test Suite
+=================
+
+.. automodule:: tests.TestSuite_os_udp
+   :members:
+   :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst b/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
new file mode 100644
index 0000000000..b6571b24f5
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_pmd_buffer_scatter.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+pmd_buffer_scatter Test Suite
+=============================
+
+.. automodule:: tests.TestSuite_pmd_buffer_scatter
+   :members:
+   :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_smoke_tests.rst b/doc/api/dts/tests.TestSuite_smoke_tests.rst
new file mode 100644
index 0000000000..5b11aa7f48
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_smoke_tests.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+smoke_tests Test Suite
+======================
+
+.. automodule:: tests.TestSuite_smoke_tests
+   :members:
+   :show-inheritance:
+
diff --git a/doc/api/dts/tests.TestSuite_vlan.rst b/doc/api/dts/tests.TestSuite_vlan.rst
new file mode 100644
index 0000000000..86a29538bb
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_vlan.rst
@@ -0,0 +1,10 @@
+
+.. SPDX-License-Identifier: BSD-3-Clause
+
+vlan Test Suite
+===============
+
+.. automodule:: tests.TestSuite_vlan
+   :members:
+   :show-inheritance:
+
diff --git a/doc/api/dts/tests.rst b/doc/api/dts/tests.rst
new file mode 100644
index 0000000000..0c136b4bb0
--- /dev/null
+++ b/doc/api/dts/tests.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+tests - Test Suites Package
+==============================
+
+.. automodule:: tests
+   :members:
+   :show-inheritance:
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   tests.TestSuite_hello_world
+   tests.TestSuite_os_udp
+   tests.TestSuite_pmd_buffer_scatter
+   tests.TestSuite_smoke_tests
+   tests.TestSuite_vlan
+
-- 
2.43.0


  reply	other threads:[~2024-11-08 13:45 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-06 16:13 [PATCH] dts: add per-test-suite configuration Luca Vizzarro
2024-09-27 17:45 ` Jeremy Spewock
2024-11-08 13:38 ` [PATCH v2 0/4] " Luca Vizzarro
2024-11-08 13:38   ` [PATCH v2 1/4] dts: add tests package to API docs Luca Vizzarro
2024-11-08 13:38   ` [PATCH v2 2/4] dts: fix smoke tests docstring Luca Vizzarro
2024-11-08 13:38   ` [PATCH v2 3/4] dts: add per-test-suite configuration Luca Vizzarro
2024-11-08 13:38   ` [PATCH v2 4/4] dts: update autodoc sorting order Luca Vizzarro
2024-11-08 13:45 ` [PATCH v3 0/4] dts: add per-test-suite configuration Luca Vizzarro
2024-11-08 13:45   ` Luca Vizzarro [this message]
2024-11-08 13:45   ` [PATCH v3 2/4] dts: fix smoke tests docstring Luca Vizzarro
2024-11-08 13:45   ` [PATCH v3 3/4] dts: add per-test-suite configuration Luca Vizzarro
2024-11-08 13:45   ` [PATCH v3 4/4] dts: update autodoc sorting order Luca Vizzarro

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=20241108134532.130681-2-luca.vizzarro@arm.com \
    --to=luca.vizzarro@arm.com \
    --cc=dev@dpdk.org \
    --cc=paul.szczepanek@arm.com \
    --cc=probb@iol.unh.edu \
    /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).