[rtems-central commit] spec: Reorder some interface groups

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    94ac94dccbe03641f87000212705a5273b9d8d7e
Changeset: http://git.rtems.org/rtems-central/commit/?id=94ac94dccbe03641f87000212705a5273b9d8d7e

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Jul 21 07:59:35 2021 +0200

spec: Reorder some interface groups

---

 spec/c/if/group.yml              | 12 +++++++-----
 spec/if/{api.yml => group.yml}   |  5 +++--
 spec/req/api.yml                 | 14 ++++++++++++++
 spec/req/applconfig.yml          |  2 +-
 spec/rtems/basedefs/if/group.yml |  4 ++--
 spec/rtems/config/if/group.yml   |  4 ++--
 spec/rtems/if/group.yml          |  2 +-
 spec/rtems/malloc/if/group.yml   |  6 +++---
 8 files changed, 33 insertions(+), 16 deletions(-)

diff --git a/spec/c/if/group.yml b/spec/c/if/group.yml
index 866b53d..94e5bc3 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
similarity index 79%
rename from spec/if/api.yml
rename to spec/if/group.yml
index a35fa72..a96facd 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 0000000..4a062cd
--- /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 a8ec5ea..d1f808c 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 1237b26..715dd13 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 dc1a543..c0631b9 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 ddfbd6b..a6006ed 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 7ee4e58..d19dd04 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