From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 50E7D45CB5; Fri, 8 Nov 2024 14:38:54 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A2E00433CC; Fri, 8 Nov 2024 14:38:50 +0100 (CET) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mails.dpdk.org (Postfix) with ESMTP id 9D04F433AC for ; Fri, 8 Nov 2024 14:38:48 +0100 (CET) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id E045F497; Fri, 8 Nov 2024 05:39:17 -0800 (PST) Received: from localhost.localdomain (unknown [10.57.59.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 5A96E3F528; Fri, 8 Nov 2024 05:38:47 -0800 (PST) From: Luca Vizzarro To: dev@dpdk.org Cc: Paul Szczepanek , Patrick Robb , Luca Vizzarro Subject: [PATCH v2 1/4] dts: add tests package to API docs Date: Fri, 8 Nov 2024 13:38:39 +0000 Message-ID: <20241108133842.123782-2-luca.vizzarro@arm.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241108133842.123782-1-luca.vizzarro@arm.com> References: <20240906161355.701688-1-luca.vizzarro@arm.com> <20241108133842.123782-1-luca.vizzarro@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The test suites are not documented in the API as their respective documentation files are missing. Signed-off-by: Luca Vizzarro Reviewed-by: Paul Szczepanek --- 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