summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-07-21 07:59:35 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-07-21 16:27:38 +0200
commit94ac94dccbe03641f87000212705a5273b9d8d7e (patch)
treea69d83aa20ac7826e9d1bddcce3c7bcf6bc6ef3c
parentspecview.py: Display link roles (diff)
downloadrtems-central-94ac94dccbe03641f87000212705a5273b9d8d7e.tar.bz2
spec: Reorder some interface groups
-rw-r--r--spec/c/if/group.yml12
-rw-r--r--spec/if/group.yml (renamed from spec/if/api.yml)5
-rw-r--r--spec/req/api.yml14
-rw-r--r--spec/req/applconfig.yml2
-rw-r--r--spec/rtems/basedefs/if/group.yml4
-rw-r--r--spec/rtems/config/if/group.yml4
-rw-r--r--spec/rtems/if/group.yml2
-rw-r--r--spec/rtems/malloc/if/group.yml6
8 files changed, 33 insertions, 16 deletions
diff --git a/spec/c/if/group.yml b/spec/c/if/group.yml
index 866b53dc..94e5bc39 100644
--- a/spec/c/if/group.yml
+++ b/spec/c/if/group.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- This group contains the ${/glossary/c11:/term} and ${/glossary/posix:/term}.
+ This group contains ${/glossary/c11:/term} and ${/glossary/posix:/term}.
interfaces.
copyrights:
- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
@@ -10,10 +10,12 @@ identifier: CStd
index-entries: []
interface-type: group
links:
-- role: interface-ingroup
- uid: /if/api
+- role: requirement-refinement
+ uid: /req/api
+- role: interface-placement
+ uid: domain
name: C and POSIX
text: |
- The ${/glossary/api:/term} shall contain interfaces specified by
- ${/glossary/c11:/term} and ${/glossary/posix:/term}.
+ The ${/glossary/api:/term} shall provide interfaces specified by
+ ${/glossary/c11:/term} or ${/glossary/posix:/term}.
type: interface
diff --git a/spec/if/api.yml b/spec/if/group.yml
index a35fa72b..a96facd8 100644
--- a/spec/if/api.yml
+++ b/spec/if/group.yml
@@ -10,10 +10,11 @@ index-entries: []
interface-type: group
links:
- role: requirement-refinement
- uid: ../req/root
+ uid: ../req/api
- role: interface-placement
uid: ../rtems/basedefs/if/header
name: API
text: |
- The software product shall have an ${../glossary/api:/term}.
+ The ${../glossary/api:/term} shall provide interfaces specific to
+ ${/glossary/rtems:/term}.
type: interface
diff --git a/spec/req/api.yml b/spec/req/api.yml
new file mode 100644
index 00000000..4a062cd6
--- /dev/null
+++ b/spec/req/api.yml
@@ -0,0 +1,14 @@
+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: requirement-refinement
+ uid: api
+non-functional-type: interface-requirement
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+ The software product shall provide an ${../glossary/api:/term}.
+type: requirement
diff --git a/spec/req/applconfig.yml b/spec/req/applconfig.yml
index a8ec5ea1..d1f808c6 100644
--- a/spec/req/applconfig.yml
+++ b/spec/req/applconfig.yml
@@ -4,7 +4,7 @@ copyrights:
enabled-by: true
links:
- role: requirement-refinement
- uid: ../if/api
+ uid: api
non-functional-type: interface-requirement
rationale: null
references: []
diff --git a/spec/rtems/basedefs/if/group.yml b/spec/rtems/basedefs/if/group.yml
index 1237b264..715dd138 100644
--- a/spec/rtems/basedefs/if/group.yml
+++ b/spec/rtems/basedefs/if/group.yml
@@ -13,8 +13,8 @@ links:
- role: interface-placement
uid: header
- role: interface-ingroup
- uid: /if/api
+ uid: /if/group
name: Base Definitions
text: |
- The API shall provide an interface to compiler-specific features.
+ The RTEMS API shall provide an interface to compiler-specific features.
type: interface
diff --git a/spec/rtems/config/if/group.yml b/spec/rtems/config/if/group.yml
index dc1a5438..c0631b9d 100644
--- a/spec/rtems/config/if/group.yml
+++ b/spec/rtems/config/if/group.yml
@@ -15,9 +15,9 @@ links:
- role: interface-placement
uid: header
- role: interface-ingroup
- uid: /if/api
+ uid: /if/group
name: Application Configuration Information
text: |
- The API shall provide an interface to get the configuration of an
+ The RTEMS API shall provide an interface to get the configuration of an
application.
type: interface
diff --git a/spec/rtems/if/group.yml b/spec/rtems/if/group.yml
index ddfbd6bc..a6006ede 100644
--- a/spec/rtems/if/group.yml
+++ b/spec/rtems/if/group.yml
@@ -12,7 +12,7 @@ links:
- role: interface-placement
uid: header
- role: interface-ingroup
- uid: /if/api
+ uid: /if/group
name: Classic
text: |
The API shall contain the Classic API.
diff --git a/spec/rtems/malloc/if/group.yml b/spec/rtems/malloc/if/group.yml
index 7ee4e580..d19dd046 100644
--- a/spec/rtems/malloc/if/group.yml
+++ b/spec/rtems/malloc/if/group.yml
@@ -12,9 +12,9 @@ links:
- role: interface-placement
uid: header
- role: interface-ingroup
- uid: /if/api
+ uid: /if/group
name: Dynamic Memory Allocation
text: |
- The ${/glossary/api:/term} shall provide an interface to the dynamic memory
- allocation services.
+ The RTEMS API shall provide an interface to the dynamic memory allocation
+ services.
type: interface