diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-05 08:42:23 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-05 10:38:51 +0200 |
commit | 8bc24e5f54eac0084e4b02e44ad218d385f4c67f (patch) | |
tree | bc30a32d223a0844929d89a77ef5f11b91e99b1f | |
parent | eng: Add design target item type (diff) | |
download | rtems-docs-8bc24e5f54eac0084e4b02e44ad218d385f4c67f.tar.bz2 |
eng: Add proxy item type
Update #3715.
-rw-r--r-- | eng/req/items.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/eng/req/items.rst b/eng/req/items.rst index e51072b..ce6a435 100644 --- a/eng/req/items.rst +++ b/eng/req/items.rst @@ -99,6 +99,8 @@ The specification item types have the following hierarchy: * :ref:`SpecTypeInterfaceVariableItemType` + * :ref:`SpecTypeProxyItemTypes` + * :ref:`SpecTypeRequirementItemType` * :ref:`SpecTypeFunctionalRequirementItemType` @@ -193,6 +195,8 @@ This type is refined by the following types: * :ref:`SpecTypeInterfaceItemType` +* :ref:`SpecTypeProxyItemTypes` + * :ref:`SpecTypeRequirementItemType` * :ref:`SpecTypeRequirementValidationItemType` @@ -1607,6 +1611,20 @@ name notes The attribute value shall be an :ref:`SpecTypeInterfaceNotes`. +.. _SpecTypeProxyItemTypes: + +Proxy Item Types +^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeRootItemType` through the ``type`` +attribute if the value is ``proxy``. Items of similar characteristics may link +to a proxy item through links with the :ref:`SpecTypeProxyMemberLinkRole`. A +proxy item resolves to the first member item which is enabled. Proxies may be +used to provide an interface with a common name and implementations which +depend on configuration options. For example, in one configuration a constant +could be a compile time constant and in another configuration it could be a +read-only object. + .. _SpecTypeRequirementItemType: Requirement Item Type @@ -4575,6 +4593,8 @@ This type is refined by the following types: * :ref:`SpecTypePlacementOrderLinkRole` +* :ref:`SpecTypeProxyMemberLinkRole` + * :ref:`SpecTypeRequirementRefinementLinkRole` * :ref:`SpecTypeRequirementValidationLinkRole` @@ -4689,6 +4709,15 @@ value is ``placement-order``. This link role defines the placement order of items in a container item (for example an interface function in a header file or a documentation section). +.. _SpecTypeProxyMemberLinkRole: + +Proxy Member Link Role +^^^^^^^^^^^^^^^^^^^^^^ + +This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the +value is ``proxy-member``. It defines the proxy member role of links. Items +may use this role to link to :ref:`SpecTypeProxyItemTypes` items. + .. _SpecTypeRequirementRefinementLinkRole: Requirement Refinement Link Role |