[rtems-central commit] spec: Use design groups

Sebastian Huber sebh at rtems.org
Wed Sep 15 13:42:37 UTC 2021 

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Sep 15 13:41:43 2021 +0200

spec: Use design groups

---

 spec/rtems/attr/if/header.yml             |  2 ++
 spec/rtems/attr/req/group.yml             | 16 ++++++++++++++++
 spec/rtems/barrier/if/header.yml          |  2 ++
 spec/rtems/barrier/req/group.yml          | 16 ++++++++++++++++
 spec/rtems/clock/if/header.yml            |  2 ++
 spec/rtems/clock/req/group.yml            | 16 ++++++++++++++++
 spec/rtems/event/req/group.yml            |  2 +-
 spec/rtems/message/if/header.yml          |  2 ++
 spec/rtems/message/req/group.yml          | 18 ++++++++----------
 spec/rtems/part/req/group.yml             |  2 +-
 spec/rtems/ratemon/glossary/ownertask.yml |  2 +-
 spec/rtems/ratemon/if/header.yml          |  2 ++
 spec/rtems/ratemon/req/group.yml          | 18 ++++++++----------
 spec/rtems/req/group.yml                  | 16 ++++++----------
 spec/rtems/sem/if/header.yml              |  2 ++
 spec/rtems/sem/req/group.yml              | 18 ++++++++----------
 spec/rtems/task/if/header.yml             |  2 ++
 spec/rtems/task/req/group.yml             | 16 ++++++++++++++++
 spec/rtems/timer/req/group.yml            |  2 +-
 spec/rtems/userext/req/group.yml          |  2 +-
 20 files changed, 113 insertions(+), 45 deletions(-)

diff --git a/spec/rtems/attr/if/header.yml b/spec/rtems/attr/if/header.yml
index 1103e90..7d8b8c6 100644
--- a/spec/rtems/attr/if/header.yml
+++ b/spec/rtems/attr/if/header.yml
@@ -9,6 +9,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/attr.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/attr/req/group.yml b/spec/rtems/attr/req/group.yml
new file mode 100644
index 0000000..638f545
--- /dev/null
+++ b/spec/rtems/attr/req/group.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+identifier: RTEMSImplClassicAttr
+links:
+- role: interface-ingroup
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+  The software architecture shall have a component containing the attribute
+  support implementation.
+type: requirement
diff --git a/spec/rtems/barrier/if/header.yml b/spec/rtems/barrier/if/header.yml
index 213203e..4821751 100644
--- a/spec/rtems/barrier/if/header.yml
+++ b/spec/rtems/barrier/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/barrier.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/barrier/req/group.yml b/spec/rtems/barrier/req/group.yml
new file mode 100644
index 0000000..f3fa342
--- /dev/null
+++ b/spec/rtems/barrier/req/group.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+identifier: RTEMSImplClassicBarrier
+links:
+- role: interface-ingroup
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+  The software architecture shall have a component containing the Barrier
+  Manager implementation.
+type: requirement
diff --git a/spec/rtems/clock/if/header.yml b/spec/rtems/clock/if/header.yml
index 2cfd3c0..02ef8a9 100644
--- a/spec/rtems/clock/if/header.yml
+++ b/spec/rtems/clock/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/clock.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/clock/req/group.yml b/spec/rtems/clock/req/group.yml
new file mode 100644
index 0000000..d110dc9
--- /dev/null
+++ b/spec/rtems/clock/req/group.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+identifier: RTEMSImplClassicClock
+links:
+- role: interface-ingroup
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+  The software architecture shall have a component containing the Clock Manager
+  implementation.
+type: requirement
diff --git a/spec/rtems/event/req/group.yml b/spec/rtems/event/req/group.yml
index fb17d3f..c75a5ad 100644
--- a/spec/rtems/event/req/group.yml
+++ b/spec/rtems/event/req/group.yml
@@ -5,7 +5,7 @@ enabled-by: true
 identifier: RTEMSImplClassicEvent
 links:
 - role: interface-ingroup
-  uid: /req/impl
+  uid: ../../req/group
 non-functional-type: design-group
 rationale: null
 references: []
diff --git a/spec/rtems/message/if/header.yml b/spec/rtems/message/if/header.yml
index c11503f..139823a 100644
--- a/spec/rtems/message/if/header.yml
+++ b/spec/rtems/message/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/message.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/message/req/group.yml b/spec/rtems/message/req/group.yml
index c808530..c2aa9a6 100644
--- a/spec/rtems/message/req/group.yml
+++ b/spec/rtems/message/req/group.yml
@@ -1,18 +1,16 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  This group contains the Message Manager implementation.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
-identifier: ClassicMessageQueueImpl
-index-entries: []
-interface-type: group
+identifier: RTEMSImplClassicMessage
 links:
 - role: interface-ingroup
-  uid: ../../if/group
-name: Message Manager
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
 text: |
   The software architecture shall have a component containing the Message
   Manager implementation.
-type: interface
+type: requirement
diff --git a/spec/rtems/part/req/group.yml b/spec/rtems/part/req/group.yml
index be38421..6050537 100644
--- a/spec/rtems/part/req/group.yml
+++ b/spec/rtems/part/req/group.yml
@@ -5,7 +5,7 @@ enabled-by: true
 identifier: RTEMSImplClassicPartition
 links:
 - role: interface-ingroup
-  uid: /req/impl
+  uid: ../../req/group
 non-functional-type: design-group
 rationale: null
 references: []
diff --git a/spec/rtems/ratemon/glossary/ownertask.yml b/spec/rtems/ratemon/glossary/ownertask.yml
index 6419087..10042c3 100644
--- a/spec/rtems/ratemon/glossary/ownertask.yml
+++ b/spec/rtems/ratemon/glossary/ownertask.yml
@@ -11,7 +11,7 @@ text: |
   The owner ${/glossary/task:/term} of a period is the ${/glossary/task:/term}
   which created it by successfully invoking ${../if/create:/name}.  The
   ${/glossary/task:/term} looses the ownership when the period is deleted
-  by a call to ${../if/delete:/name}.  The ${../req/group:/name} permits
+  by a call to ${../if/delete:/name}.  The ${../if/group:/name} permits
   only the ${/glossary/task:/term} owning a period to invoke
   ${../if/period:/name}.
 type: glossary
diff --git a/spec/rtems/ratemon/if/header.yml b/spec/rtems/ratemon/if/header.yml
index 330237f..442e05c 100644
--- a/spec/rtems/ratemon/if/header.yml
+++ b/spec/rtems/ratemon/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/ratemon.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/ratemon/req/group.yml b/spec/rtems/ratemon/req/group.yml
index 22a70c8..24d79b7 100644
--- a/spec/rtems/ratemon/req/group.yml
+++ b/spec/rtems/ratemon/req/group.yml
@@ -1,18 +1,16 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  This group contains the Rate Monotonic Manager implementation.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
-identifier: ClassicRateMonImpl
-index-entries: []
-interface-type: group
+identifier: RTEMSImplClassicRateMonotonic
 links:
 - role: interface-ingroup
-  uid: ../../if/group
-name: Rate Monotonic Manager
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
 text: |
   The software architecture shall have a component containing the Rate
   Monotonic Manager implementation.
-type: interface
+type: requirement
diff --git a/spec/rtems/req/group.yml b/spec/rtems/req/group.yml
index af515e4..9be3438 100644
--- a/spec/rtems/req/group.yml
+++ b/spec/rtems/req/group.yml
@@ -1,20 +1,16 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  This group contains the Classic API implementation.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 identifier: RTEMSImplClassic
-index-entries: []
-interface-type: group
 links:
 - role: interface-ingroup
   uid: /req/impl
-- role: interface-placement
-  uid: /rtems/type/if/header
-name: Classic API
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
 text: |
   The software architecture shall have a component containing the Classic API
   implementation.
-type: interface
+type: requirement
diff --git a/spec/rtems/sem/if/header.yml b/spec/rtems/sem/if/header.yml
index 69138d9..431d0d8 100644
--- a/spec/rtems/sem/if/header.yml
+++ b/spec/rtems/sem/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/sem.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/sem/req/group.yml b/spec/rtems/sem/req/group.yml
index dd8ef94..a158c7c 100644
--- a/spec/rtems/sem/req/group.yml
+++ b/spec/rtems/sem/req/group.yml
@@ -1,18 +1,16 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  This group contains the Semaphore Manager implementation.
 copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: null
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
-identifier: ClassicSemImpl
-index-entries: []
-interface-type: group
+identifier: RTEMSImplClassicSemaphore
 links:
 - role: interface-ingroup
-  uid: ../../if/group
-name: Semaphore Manager
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
 text: |
   The software architecture shall have a component containing the Semaphore
   Manager implementation.
-type: interface
+type: requirement
diff --git a/spec/rtems/task/if/header.yml b/spec/rtems/task/if/header.yml
index e44cc22..5b8ee8d 100644
--- a/spec/rtems/task/if/header.yml
+++ b/spec/rtems/task/if/header.yml
@@ -8,6 +8,8 @@ interface-type: header-file
 links:
 - role: interface-placement
   uid: /if/domain
+- role: interface-ingroup
+  uid: ../req/group
 path: rtems/rtems/tasks.h
 prefix: cpukit/include
 type: interface
diff --git a/spec/rtems/task/req/group.yml b/spec/rtems/task/req/group.yml
new file mode 100644
index 0000000..a33fe2e
--- /dev/null
+++ b/spec/rtems/task/req/group.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+identifier: RTEMSImplClassicTask
+links:
+- role: interface-ingroup
+  uid: ../../req/group
+non-functional-type: design-group
+rationale: null
+references: []
+requirement-type: non-functional
+text: |
+  The software architecture shall have a component containing the Task Manager
+  implementation.
+type: requirement
diff --git a/spec/rtems/timer/req/group.yml b/spec/rtems/timer/req/group.yml
index 1164868..1d42485 100644
--- a/spec/rtems/timer/req/group.yml
+++ b/spec/rtems/timer/req/group.yml
@@ -5,7 +5,7 @@ enabled-by: true
 identifier: RTEMSImplClassicTimer
 links:
 - role: interface-ingroup
-  uid: /req/impl
+  uid: ../../req/group
 non-functional-type: design-group
 rationale: null
 references: []
diff --git a/spec/rtems/userext/req/group.yml b/spec/rtems/userext/req/group.yml
index 0c76e94..6836cf2 100644
--- a/spec/rtems/userext/req/group.yml
+++ b/spec/rtems/userext/req/group.yml
@@ -5,7 +5,7 @@ enabled-by: true
 identifier: RTEMSImplClassicUserExt
 links:
 - role: interface-ingroup
-  uid: /req/impl
+  uid: ../../req/group
 non-functional-type: design-group
 rationale: null
 references: []

More information about the vc mailing list