summaryrefslogtreecommitdiffstats
path: root/rtemsspec/tests/test_applconfig.py
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-15 18:58:27 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-16 13:57:51 +0100
commit1500c767cad116c6611fb85f4f806818052a4904 (patch)
treec6cb8614e56de5fb188c2dbf5a4a7aa58f761107 /rtemsspec/tests/test_applconfig.py
parentinterface: Support constraints for defines (diff)
downloadrtems-central-1500c767cad116c6611fb85f4f806818052a4904.tar.bz2
applconfig: Use rubric instead of definition list
Generalize value constraints to constraints. For direcives and application configuration options use the same rubric order.
Diffstat (limited to 'rtemsspec/tests/test_applconfig.py')
-rw-r--r--rtemsspec/tests/test_applconfig.py301
1 files changed, 161 insertions, 140 deletions
diff --git a/rtemsspec/tests/test_applconfig.py b/rtemsspec/tests/test_applconfig.py
index c2ebd770..c88f537f 100644
--- a/rtemsspec/tests/test_applconfig.py
+++ b/rtemsspec/tests/test_applconfig.py
@@ -80,46 +80,51 @@ description
a
-
-CONSTANT:
- ``a``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``a``
-DEFAULT CONFIGURATION:
- default a
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- description a
+This configuration option is a boolean feature define.
-NOTES:
- notes a
+.. rubric:: DEFAULT CONFIGURATION:
- references:
+default a
- * :ref:`b`
+.. rubric:: DESCRIPTION:
- * :ref:`SphinxRefUnspecGroup`
+description a
- * Unspec Group 2
+.. rubric:: NOTES:
- * `Unspec Group 3 <unspec-group-3.html>`_
+notes a
- * :ref:`unspec_func() <SphinxRefUnspecFunc>`
+references:
- * :c:func:`func`
+* :ref:`b`
- * :c:type:`td`
+* :ref:`SphinxRefUnspecGroup`
- * :c:macro:`DEFINE`
+* Unspec Group 2
- * :ref:`UNSPEC_DEFINE <SphinxRefTarget>`
+* `Unspec Group 3 <unspec-group-3.html>`_
- * `UNSPEC_DEFINE_2 <https://foo>`_
+* :ref:`unspec_func() <SphinxRefUnspecFunc>`
- * :c:type:`unspec_type`
+* :c:func:`func`
- * `unspec_type_2 <https://bar>`_
+* :c:type:`td`
+
+* :c:macro:`DEFINE`
+
+* :ref:`UNSPEC_DEFINE <SphinxRefTarget>`
+
+* `UNSPEC_DEFINE_2 <https://foo>`_
+
+* :c:type:`unspec_type`
+
+* `unspec_type_2 <https://bar>`_
.. Generated from spec:/b
@@ -130,21 +135,22 @@ NOTES:
b
-
-CONSTANT:
- ``b``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is a boolean feature define.
+``b``
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- description b
+This configuration option is a boolean feature define.
-NOTES:
- None.
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
+
+.. rubric:: DESCRIPTION:
+
+description b
.. Generated from spec:/c
@@ -155,23 +161,29 @@ NOTES:
c
-
-CONSTANT:
- ``c``
+.. rubric:: CONSTANT:
+
+``c``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is an integer define.
+This configuration option is an integer define.
-DEFAULT VALUE:
- The default value is 13.
+.. rubric:: DEFAULT VALUE:
-VALUE CONSTRAINTS:
- constraint d
+The default value is 13.
-DESCRIPTION:
- description c
+.. rubric:: DESCRIPTION:
-NOTES:
- notes c
+description c
+
+.. rubric:: NOTES:
+
+notes c
+
+.. rubric:: CONSTRAINTS:
+
+constraint d
.. Generated from spec:/e
@@ -182,20 +194,21 @@ NOTES:
e
-
-CONSTANT:
- ``e``
+.. rubric:: CONSTANT:
+
+``e``
-OPTION TYPE:
- This configuration option is an integer define.
+.. rubric:: OPTION TYPE:
-DEFAULT VALUE:
- The default value is 7.
+This configuration option is an integer define.
-DESCRIPTION:
- description e
+.. rubric:: DEFAULT VALUE:
-NOTES:
- None.
+The default value is 7.
+
+.. rubric:: DESCRIPTION:
+
+description e
.. Generated from spec:/f
@@ -206,20 +219,21 @@ NOTES:
f
-
-CONSTANT:
- ``f``
+.. rubric:: CONSTANT:
+
+``f``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
-OPTION TYPE:
- This configuration option is an integer define.
+.. rubric:: DEFAULT VALUE:
-DEFAULT VALUE:
- The default value is 1.
+The default value is 1.
-DESCRIPTION:
- description f
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+description f
.. Generated from spec:/h
@@ -230,20 +244,21 @@ NOTES:
h
-
-CONSTANT:
- ``h``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is an integer define.
+``h``
-DEFAULT VALUE:
- The default value is 1.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- description h
+This configuration option is an integer define.
-NOTES:
- None.
+.. rubric:: DEFAULT VALUE:
+
+The default value is 1.
+
+.. rubric:: DESCRIPTION:
+
+description h
.. Generated from spec:/i
@@ -254,20 +269,21 @@ NOTES:
i
-
-CONSTANT:
- ``i``
+.. rubric:: CONSTANT:
+
+``i``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is an integer define.
+This configuration option is an integer define.
-DEFAULT VALUE:
- The default value is 1.
+.. rubric:: DEFAULT VALUE:
-DESCRIPTION:
- description i
+The default value is 1.
-NOTES:
- None.
+.. rubric:: DESCRIPTION:
+
+description i
.. Generated from spec:/j
@@ -278,23 +294,25 @@ NOTES:
j
-
-CONSTANT:
- ``j``
+.. rubric:: CONSTANT:
+
+``j``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an integer define.
+
+.. rubric:: DEFAULT VALUE:
-OPTION TYPE:
- This configuration option is an integer define.
+Foo bar.
-DEFAULT VALUE:
- Foo bar.
+.. rubric:: DESCRIPTION:
-VALUE CONSTRAINTS:
- constraint d
+description j
-DESCRIPTION:
- description j
+.. rubric:: CONSTRAINTS:
-NOTES:
- None.
+constraint d
.. Generated from spec:/k
@@ -305,20 +323,21 @@ NOTES:
k
-
-CONSTANT:
- ``k``
+.. rubric:: CONSTANT:
-OPTION TYPE:
- This configuration option is an integer define.
+``k``
-DEFAULT VALUE:
- The default value is 1.
+.. rubric:: OPTION TYPE:
-DESCRIPTION:
- description k
+This configuration option is an integer define.
-NOTES:
- None.
+.. rubric:: DEFAULT VALUE:
+
+The default value is 1.
+
+.. rubric:: DESCRIPTION:
+
+description k
.. Generated from spec:/l
@@ -329,28 +348,29 @@ NOTES:
l
-
-CONSTANT:
- ``l``
+.. rubric:: CONSTANT:
+
+``l``
+
+.. rubric:: OPTION TYPE:
-OPTION TYPE:
- This configuration option is an initializer define.
+This configuration option is an initializer define.
-DEFAULT VALUE:
- The default value is 1.
+.. rubric:: DEFAULT VALUE:
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+The default value is 1.
- * It shall be greater than or equal to zero.
+.. rubric:: DESCRIPTION:
- * It shall be less than or equal to two.
+description l
-DESCRIPTION:
- description l
+.. rubric:: CONSTRAINTS:
-NOTES:
- None.
+The following constraints apply to this configuration option:
+
+* The value of the configuration option shall be greater than or equal to zero.
+
+* The value of the configuration option shall be less than or equal to two.
.. Generated from spec:/m
@@ -361,20 +381,21 @@ NOTES:
m
-
-CONSTANT:
- ``m``
+.. rubric:: CONSTANT:
+
+``m``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an initializer define.
-OPTION TYPE:
- This configuration option is an initializer define.
+.. rubric:: DEFAULT VALUE:
-DEFAULT VALUE:
- The default value is 1.
+The default value is 1.
-DESCRIPTION:
- description m
+.. rubric:: DESCRIPTION:
-NOTES:
- None.
+description m
"""
assert content == src.read()
with open(doxygen_h, "r") as src:
@@ -506,7 +527,7 @@ NOTES:
* @par Default Value
* The default value is 13.
*
- * @par Value Constraints
+ * @par Constraints
* constraint d
*
* @par Notes
@@ -572,7 +593,7 @@ NOTES:
* @par Default Value
* Foo bar.
*
- * @par Value Constraints
+ * @par Constraints
* constraint d
*/
#define j
@@ -599,14 +620,14 @@ NOTES:
* @par Default Value
* The default value is 1.
*
- * @par Value Constraints
+ * @par Constraints
* @parblock
- * The value of this configuration option shall satisfy all of the following
- * constraints:
+ * The following constraints apply to this configuration option:
*
- * * It shall be greater than or equal to zero.
+ * * The value of the configuration option shall be greater than or equal to
+ * zero.
*
- * * It shall be less than or equal to two.
+ * * The value of the configuration option shall be less than or equal to two.
* @endparblock
*/
#define l