The QinQ test suite was added to DTS without an RST file. This patch
adds the missing RST file in the doc/api/dts directory. After adding
the RST file, the docs failed to build due to indents in the test
suite docstring. These indents were removed to resolve this issue.
Bugzilla ID: 1874
Fixes: 4f69c54bbb2b ("dts: add QinQ test suite")
Signed-off-by: Andrew Bailey <[email protected]>
---
doc/api/dts/tests.TestSuite_qinq.rst | 8 ++++++++
dts/tests/TestSuite_qinq.py | 5 +++--
2 files changed, 11 insertions(+), 2 deletions(-)
create mode 100644 doc/api/dts/tests.TestSuite_qinq.rst
diff --git a/doc/api/dts/tests.TestSuite_qinq.rst
b/doc/api/dts/tests.TestSuite_qinq.rst
new file mode 100644
index 0000000000..827174fcad
--- /dev/null
+++ b/doc/api/dts/tests.TestSuite_qinq.rst
@@ -0,0 +1,8 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+
+qinq Test Suite
+===============
+
+.. automodule:: tests.TestSuite_qinq
+ :members:
+ :show-inheritance:
\ No newline at end of file
diff --git a/dts/tests/TestSuite_qinq.py b/dts/tests/TestSuite_qinq.py
index bb385a0d91..505d71dbc8 100644
--- a/dts/tests/TestSuite_qinq.py
+++ b/dts/tests/TestSuite_qinq.py
@@ -26,10 +26,11 @@ class TestQinq(TestSuite):
"""QinQ test suite.
This suite consists of 2 test cases:
+
1. QinQ Forwarding: Send a QinQ packet and verify the received packet
contains
- both QinQ/VLAN layers.
+ both QinQ/VLAN layers.
2. QinQ Strip: Enable VLAN/QinQ stripping and verify sent packets are
received with the
- expected VLAN/QinQ layers.
+ expected VLAN/QinQ layers.
"""
def _send_packet_and_verify(
--
2.50.1
