summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-04 11:22:39 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-04 15:06:12 +0200
commit0c43c520c84474c181fd32ede5f2aab65aee7072 (patch)
tree1f53116e19740f427dfda46785348e67cf45f91d
parenteng: Simplify wording for specification items (diff)
downloadrtems-docs-0c43c520c84474c181fd32ede5f2aab65aee7072.tar.bz2
eng: Add generic attribute key types
Update #3715.
-rw-r--r--eng/req/items.rst63
1 files changed, 37 insertions, 26 deletions
diff --git a/eng/req/items.rst b/eng/req/items.rst
index 6bf992f..cf0805d 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -2447,8 +2447,8 @@ Build Option Set Test State Action
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This set of attributes specifies test states for a set of test programs.
-Generic attributes may be specified. Each attribute key shall be a
-:ref:`SpecTypeName`. The attribute value shall be a
+Generic attributes may be specified. Each generic attribute key shall be a
+:ref:`SpecTypeName`. Each generic attribute value shall be a
:ref:`SpecTypeBuildTestState`. The keys shall be test program names. The names
shall correspond to the name of a :ref:`SpecTypeBuildTestProgramItemType` or
:ref:`SpecTypeBuildAdaTestProgramItemType` item. Due to the processing order
@@ -3385,6 +3385,8 @@ This type is used by the following types:
* :ref:`SpecTypeBuildItemType`
+* :ref:`SpecTypeBuildOptionSetTestStateAction`
+
* :ref:`SpecTypeGlossaryItemType`
* :ref:`SpecTypeInterfaceItemType`
@@ -3397,6 +3399,8 @@ This type is used by the following types:
* :ref:`SpecTypeSpecificationAttributeValue`
+* :ref:`SpecTypeSpecificationExplicitAttributes`
+
* :ref:`SpecTypeSpecificationGenericAttributes`
* :ref:`SpecTypeSpecificationItemType`
@@ -3715,20 +3719,6 @@ This type is used by the following types:
* :ref:`SpecTypeRootItemType`
-.. _SpecTypeSpecificationAttribute:
-
-Specification Attribute
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Generic attributes may be specified. Each attribute key shall be a
-:ref:`SpecTypeName`. The attribute value shall be a
-:ref:`SpecTypeSpecificationAttributeValue`. The generic attributes specify an
-attribute set.
-
-This type is used by the following types:
-
-* :ref:`SpecTypeSpecificationAttributeSet`
-
.. _SpecTypeSpecificationAttributeSet:
Specification Attribute Set
@@ -3746,8 +3736,9 @@ attributes are mandatory:
The explicit attributes for this type are:
attributes
- The attribute value shall be a :ref:`SpecTypeSpecificationAttribute`. It
- shall be the specification of the set of explicit attributes.
+ The attribute value shall be a
+ :ref:`SpecTypeSpecificationExplicitAttributes`. It shall specify the
+ explicit attributes of the attribute set.
description
The attribute value shall be an optional string. It shall be the
@@ -3755,12 +3746,12 @@ description
generic-attributes
The attribute value shall be a
- :ref:`SpecTypeSpecificationGenericAttributes`. It shall be the
- specification of the generic attributes of the attribute set.
+ :ref:`SpecTypeSpecificationGenericAttributes`. It shall specify the generic
+ attributes of the attribute set.
mandatory-attributes
The attribute value shall be a
- :ref:`SpecTypeSpecificationMandatoryAttributes`. It shall be the set of
+ :ref:`SpecTypeSpecificationMandatoryAttributes`. It shall specify the
mandatory attributes of the attribute set.
This type is used by the following types:
@@ -3785,7 +3776,7 @@ spec-type
This type is used by the following types:
-* :ref:`SpecTypeSpecificationAttribute`
+* :ref:`SpecTypeSpecificationExplicitAttributes`
.. _SpecTypeSpecificationBooleanValue:
@@ -3812,6 +3803,21 @@ This type is used by the following types:
* :ref:`SpecTypeSpecificationInformation`
+.. _SpecTypeSpecificationExplicitAttributes:
+
+Specification Explicit Attributes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Generic attributes may be specified. Each generic attribute key shall be a
+:ref:`SpecTypeName`. Each generic attribute value shall be a
+:ref:`SpecTypeSpecificationAttributeValue`. Each generic attribute specifies an
+explicit attribute of the attribute set. The key of the each generic attribute
+defines the attribute key of the explicit attribute.
+
+This type is used by the following types:
+
+* :ref:`SpecTypeSpecificationAttributeSet`
+
.. _SpecTypeSpecificationFloatingXPointAssert:
Specification Floating-Point Assert
@@ -3916,15 +3922,20 @@ Specification Generic Attributes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This set of attributes specifies generic attributes. Generic attributes are
-attributes which are not explicitly defined. They are restricted to a uniform
-attribute value type. All explicit attributes shall be specified. The explicit
-attributes for this type are:
+attributes which are not explicitly specified by
+:ref:`SpecTypeSpecificationExplicitAttributes`. They are restricted to uniform
+attribute key and value types. All explicit attributes shall be specified. The
+explicit attributes for this type are:
description
The attribute value shall be an optional string. It shall be the
description of the generic attributes.
-spec-type
+key-spec-type
+ The attribute value shall be a :ref:`SpecTypeName`. It shall be the
+ specification type of the generic attribute keys.
+
+value-spec-type
The attribute value shall be a :ref:`SpecTypeName`. It shall be the
specification type of the generic attribute values.