summaryrefslogtreecommitdiffstats
path: root/spec/spec
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-27 11:40:06 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit08c0232545d9c673fab36a37d2cc9fa15fe7f007 (patch)
tree8e96f85be45991e62d5bc8a5810d671c9c2f7447 /spec/spec
parentspec: Add interface-target link role (diff)
downloadrtems-central-08c0232545d9c673fab36a37d2cc9fa15fe7f007.tar.bz2
spec: Add interface domain items
Diffstat (limited to 'spec/spec')
-rw-r--r--spec/spec/interface-container.yml11
-rw-r--r--spec/spec/interface-domain.yml33
-rw-r--r--spec/spec/interface-header-file.yml9
3 files changed, 42 insertions, 11 deletions
diff --git a/spec/spec/interface-container.yml b/spec/spec/interface-container.yml
index 9a1ea2b9..8106ea06 100644
--- a/spec/spec/interface-container.yml
+++ b/spec/spec/interface-container.yml
@@ -13,13 +13,12 @@ spec-description: null
spec-example: null
spec-info:
dict:
- attributes:
- domain:
- description: |
- It shall be the interface domain name.
- spec-type: str
+ attributes: {}
description: |
- This set of attributes specifies an interface container.
+ Items of this type specify an interface container. The item shall have
+ exactly one link with the :ref:`SpecTypeInterfacePlacementLinkRole` to an
+ :ref:`SpecTypeInterfaceDomainItemType` item. This link defines the
+ interface domain of the container.
required-attributes: all
spec-name: Interface Container Item Type
spec-type: interface-container
diff --git a/spec/spec/interface-domain.yml b/spec/spec/interface-domain.yml
new file mode 100644
index 00000000..327b05ba
--- /dev/null
+++ b/spec/spec/interface-domain.yml
@@ -0,0 +1,33 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links:
+- role: spec-member
+ uid: root
+- role: spec-refinement
+ spec-key: interface-type
+ spec-value: domain
+ uid: interface
+spec-description: null
+spec-example: null
+spec-info:
+ dict:
+ attributes:
+ description:
+ description: |
+ It shall be the description of the domain
+ spec-type: str
+ name:
+ description: |
+ It shall be the human readable name of the domain.
+ spec-type: str
+ description: |
+ This set of attributes specifies an interface domain. Items of the types
+ :ref:`SpecTypeInterfaceContainerItemType` and
+ :ref:`SpecTypeInterfaceHeaderFileItemType` are placed into domains
+ through links with the :ref:`SpecTypeInterfacePlacementLinkRole`.
+ required-attributes: all
+spec-name: Interface Domain Item Type
+spec-type: interface-domain
+type: spec
diff --git a/spec/spec/interface-header-file.yml b/spec/spec/interface-header-file.yml
index 4accb1c0..105e441d 100644
--- a/spec/spec/interface-header-file.yml
+++ b/spec/spec/interface-header-file.yml
@@ -14,10 +14,6 @@ spec-example: null
spec-info:
dict:
attributes:
- domain:
- description: |
- It shall be the interface domain name.
- spec-type: str
path:
description: |
It shall be the path used to include the header file. For example
@@ -29,7 +25,10 @@ spec-info:
interface domain. For example :file:`cpukit/include`.
spec-type: str
description: |
- This set of attributes specifies a header file.
+ This set of attributes specifies a header file. The item shall have
+ exactly one link with the :ref:`SpecTypeInterfacePlacementLinkRole` to an
+ :ref:`SpecTypeInterfaceDomainItemType` item. This link defines the
+ interface domain of the header file.
required-attributes: all
spec-name: Interface Header File Item Type
spec-type: interface-header-file