summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-24 20:44:56 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-24 20:46:09 +0200
commit86dbbfa4f84ba3a9059f954cdb02e2439f960df4 (patch)
treeedbbd3453113ecabb53d311fdee6aa88566ab1b2
parentcead53ef13d31f19e789dd33dfeb5e2c655ffde4 (diff)
spec: Add requirements text to groups
-rw-r--r--spec/if/api.yml2
-rw-r--r--spec/if/rtems/attr/group.yml10
-rw-r--r--spec/if/rtems/barrier/group.yml10
-rw-r--r--spec/if/rtems/basedefs/group.yml10
-rw-r--r--spec/if/rtems/cache/group.yml10
-rw-r--r--spec/if/rtems/clock/group.yml10
-rw-r--r--spec/if/rtems/config/group.yml12
-rw-r--r--spec/if/rtems/dpmem/group.yml12
-rw-r--r--spec/if/rtems/event/group.yml2
-rw-r--r--spec/if/rtems/fatal/group.yml12
-rw-r--r--spec/if/rtems/group.yml8
-rw-r--r--spec/if/rtems/init/group.yml11
-rw-r--r--spec/if/rtems/intr/group.yml12
-rw-r--r--spec/if/rtems/io/group.yml12
-rw-r--r--spec/if/rtems/message/group.yml10
-rw-r--r--spec/if/rtems/modes/group.yml10
-rw-r--r--spec/if/rtems/mp/group.yml10
-rw-r--r--spec/if/rtems/object/group.yml12
-rw-r--r--spec/if/rtems/options/group.yml10
-rw-r--r--spec/if/rtems/part/group.yml10
-rw-r--r--spec/if/rtems/ratemon/group.yml12
-rw-r--r--spec/if/rtems/region/group.yml10
-rw-r--r--spec/if/rtems/sem/group.yml4
-rw-r--r--spec/if/rtems/signal/group.yml10
-rw-r--r--spec/if/rtems/status/group.yml10
-rw-r--r--spec/if/rtems/support/group.yml8
-rw-r--r--spec/if/rtems/tasks/group.yml10
-rw-r--r--spec/if/rtems/timer/group.yml8
-rw-r--r--spec/if/rtems/types/group.yml10
-rw-r--r--spec/if/rtems/userext/group.yml12
-rw-r--r--spec/spec/interface-group.yml4
31 files changed, 180 insertions, 113 deletions
diff --git a/spec/if/api.yml b/spec/if/api.yml
index 95c796c1..08d1c41b 100644
--- a/spec/if/api.yml
+++ b/spec/if/api.yml
@@ -11,4 +11,6 @@ links:
- role: interface-placement
uid: rtems/basedefs/header
name: API
+text: |
+ The system shall have an ${../glossary/api:/term}.
type: interface
diff --git a/spec/if/rtems/attr/group.yml b/spec/if/rtems/attr/group.yml
index a2fdc671..9bf22505 100644
--- a/spec/if/rtems/attr/group.yml
+++ b/spec/if/rtems/attr/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains the Classic API directive attributes.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Classic API attributes.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicAttr
interface-type: group
@@ -12,5 +12,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
-name: Attributes
+name: Directive Attributes
+text: |
+ The Classic API shall provide an interface to directive attributes.
type: interface
diff --git a/spec/if/rtems/barrier/group.yml b/spec/if/rtems/barrier/group.yml
index 7f1d4d58..9b380543 100644
--- a/spec/if/rtems/barrier/group.yml
+++ b/spec/if/rtems/barrier/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Barrier Manager provides a unique synchronization capability which can be
+ used to have a set of tasks block and be unblocked as a set.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The barrier manager provides a unique synchronization capability which can be
- used to have a set of tasks block and be unblocked as a set.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicBarrier
interface-type: group
@@ -14,5 +14,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
+text: |
+ The Classic API shall provide an interface to the Barrier Manager.
name: Barrier Manager
type: interface
diff --git a/spec/if/rtems/basedefs/group.yml b/spec/if/rtems/basedefs/group.yml
index 8d6b791d..a5340f0f 100644
--- a/spec/if/rtems/basedefs/group.yml
+++ b/spec/if/rtems/basedefs/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains basic macros and defines to give access to
+ compiler-specific features.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains basic macros to give access to compiler-specific
- features.
+description: null
enabled-by: true
identifier: RTEMSAPIBaseDefs
interface-type: group
@@ -14,4 +14,6 @@ links:
- role: interface-ingroup
uid: ../../api
name: Base Definitions
+text: |
+ The API shall provide an interface to compiler-specific features.
type: interface
diff --git a/spec/if/rtems/cache/group.yml b/spec/if/rtems/cache/group.yml
index 924d6789..d3662365 100644
--- a/spec/if/rtems/cache/group.yml
+++ b/spec/if/rtems/cache/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
+brief: |
The Cache Manager provides functions to perform maintenance operations for
data and instruction caches.
+copyrights:
+- Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicCache
interface-type: group
@@ -14,4 +14,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Cache Manager
+text: |
+ The Classic API shall provide an interface to the Cache Manager.
type: interface
diff --git a/spec/if/rtems/clock/group.yml b/spec/if/rtems/clock/group.yml
index 9606843d..3f4964e8 100644
--- a/spec/if/rtems/clock/group.yml
+++ b/spec/if/rtems/clock/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Clock Manager provides support for time of day and other time related
+ capabilities.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Clock Manager provides support for time of day and other time related
- capabilities.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicClock
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Clock Manager
+text: |
+ The Classic API shall provide an interface to the Clock Manager.
type: interface
diff --git a/spec/if/rtems/config/group.yml b/spec/if/rtems/config/group.yml
index 8c358001..c8370955 100644
--- a/spec/if/rtems/config/group.yml
+++ b/spec/if/rtems/config/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
+brief: |
This group contains defines and macros to create an application configuration
as well as functions to get values of the application configuration.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+description: null
enabled-by: true
identifier: RTEMSAPIConfig
interface-type: group
@@ -13,5 +13,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../../api
-name: Configuration
+name: Application Configuration
+text: |
+ The API shall provide an interface to the application configuration.
type: interface
diff --git a/spec/if/rtems/dpmem/group.yml b/spec/if/rtems/dpmem/group.yml
index 98a3f51e..c07fde9f 100644
--- a/spec/if/rtems/dpmem/group.yml
+++ b/spec/if/rtems/dpmem/group.yml
@@ -1,12 +1,12 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
The Dual-Ported Memory Manager provides a mechanism for converting addresses
between internal and external representations for multiple dual-ported memory
areas (DPMA).
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicDPMem
interface-type: group
@@ -16,4 +16,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Dual-Ported Memory Manager
+text: |
+ The Classic API shall provide an interface to the Dual-Ported Memory Manager.
type: interface
diff --git a/spec/if/rtems/event/group.yml b/spec/if/rtems/event/group.yml
index 1cbdddd3..05bc560c 100644
--- a/spec/if/rtems/event/group.yml
+++ b/spec/if/rtems/event/group.yml
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Event Manager
+text: |
+ The Classic API shall provide an interface to the Event Manager.
type: interface
diff --git a/spec/if/rtems/fatal/group.yml b/spec/if/rtems/fatal/group.yml
index de0790cd..5d7ad404 100644
--- a/spec/if/rtems/fatal/group.yml
+++ b/spec/if/rtems/fatal/group.yml
@@ -1,12 +1,12 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
The Fatal Error Manager processes all fatal or irrecoverable errors and other
sources of system termination (for example after ``exit()``). Fatal errors
are identified by the fatal source and error code pair.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicFatal
interface-type: group
@@ -16,4 +16,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Fatal Error Manager
+text: |
+ The Classic API shall provide an interface to the Fatal Error Manager.
type: interface
diff --git a/spec/if/rtems/group.yml b/spec/if/rtems/group.yml
index 66d78e53..332eb866 100644
--- a/spec/if/rtems/group.yml
+++ b/spec/if/rtems/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains the Classic API groups.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Classic API groups.
+description: null
enabled-by: true
identifier: RTEMSAPIClassic
interface-type: group
@@ -13,4 +13,6 @@ links:
- role: interface-ingroup
uid: ../api
name: Classic
+text: |
+ The API shall contain the Classic API.
type: interface
diff --git a/spec/if/rtems/init/group.yml b/spec/if/rtems/init/group.yml
index 1a55e227..01abba33 100644
--- a/spec/if/rtems/init/group.yml
+++ b/spec/if/rtems/init/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
+brief: |
This group contains directives to initialize and shutdown the RTEMS
executive.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicInit
interface-type: group
@@ -14,4 +14,7 @@ links:
- role: interface-ingroup
uid: ../group
name: Initialization and Shutdown
+text: |
+ The Classic API shall provide an interface to the Initialization and Shutdown
+ Manager.
type: interface
diff --git a/spec/if/rtems/intr/group.yml b/spec/if/rtems/intr/group.yml
index 180835c9..9208d41e 100644
--- a/spec/if/rtems/intr/group.yml
+++ b/spec/if/rtems/intr/group.yml
@@ -1,15 +1,15 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
Any real-time executive must provide a mechanism for quick response to
externally generated interrupts to satisfy the critical time constraints of
the application. The Interrupt Manager provides this mechanism for RTEMS.
This manager permits quick interrupt response times by providing the critical
ability to alter task execution which allows a task to be preempted upon exit
from an ISR.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicIntr
interface-type: group
@@ -19,4 +19,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Interrupt Manager
+text: |
+ The Classic API shall provide an interface to the Interrupt Manager.
type: interface
diff --git a/spec/if/rtems/io/group.yml b/spec/if/rtems/io/group.yml
index 06a406d7..74a4cf5a 100644
--- a/spec/if/rtems/io/group.yml
+++ b/spec/if/rtems/io/group.yml
@@ -1,12 +1,12 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
The Input/Output Interface Manager provides a well-defined mechanism for
accessing device drivers and a structured methodology for organizing device
drivers.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicIO
interface-type: group
@@ -16,4 +16,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Input/Output Interface Manager
+text: |
+ The Classic API shall provide an interface to the Input/Output Interface Manager.
type: interface
diff --git a/spec/if/rtems/message/group.yml b/spec/if/rtems/message/group.yml
index 3bd27212..579b70a2 100644
--- a/spec/if/rtems/message/group.yml
+++ b/spec/if/rtems/message/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Message Manager provides communication and synchronization capabilities
+ using RTEMS message queues.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Message Manager provides communication and synchronization capabilities
- using RTEMS message queues.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicMessage
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Message Manager
+text: |
+ The Classic API shall provide an interface to the Message Manager.
type: interface
diff --git a/spec/if/rtems/modes/group.yml b/spec/if/rtems/modes/group.yml
index 0179f2e8..e670054a 100644
--- a/spec/if/rtems/modes/group.yml
+++ b/spec/if/rtems/modes/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains the Classic API task modes.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Classic API modes.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicModes
interface-type: group
@@ -12,5 +12,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
-name: Modes
+name: Task Modes
+text: |
+ The Classic API shall provide an interface to task modes.
type: interface
diff --git a/spec/if/rtems/mp/group.yml b/spec/if/rtems/mp/group.yml
index f10ad505..4953390c 100644
--- a/spec/if/rtems/mp/group.yml
+++ b/spec/if/rtems/mp/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
+brief: |
The Multiprocessing Manager provides support for heterogeneous
multiprocessing systems based on message passing in a network of
multiprocessing nodes.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicMP
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Multiprocessing Manager
+text: |
+ The Classic API shall provide an interface to the Multiprocessing Manager.
type: interface
diff --git a/spec/if/rtems/object/group.yml b/spec/if/rtems/object/group.yml
index 04e98270..0f6d512a 100644
--- a/spec/if/rtems/object/group.yml
+++ b/spec/if/rtems/object/group.yml
@@ -1,13 +1,13 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
RTEMS provides a collection of services to assist in the management and usage
of the objects created and utilized via other managers. These services
assist in the manipulation of RTEMS objects independent of the API used to
create them.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicObject
interface-type: group
@@ -17,4 +17,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Object Services
+text: |
+ The Classic API shall provide an interface to the Object Services.
type: interface
diff --git a/spec/if/rtems/options/group.yml b/spec/if/rtems/options/group.yml
index f7f3c04b..0ab45b92 100644
--- a/spec/if/rtems/options/group.yml
+++ b/spec/if/rtems/options/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains the Classic API directive options.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Classic API options.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicOptions
interface-type: group
@@ -12,5 +12,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
-name: Options
+name: Directive Options
+text: |
+ The Classic API shall provide an interface to directive options.
type: interface
diff --git a/spec/if/rtems/part/group.yml b/spec/if/rtems/part/group.yml
index 483551f6..dd0b7b9b 100644
--- a/spec/if/rtems/part/group.yml
+++ b/spec/if/rtems/part/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Partition Manager provides facilities to dynamically allocate memory in
+ fixed-size units.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Partition Manager provides facilities to dynamically allocate memory in
- fixed-size units.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicPart
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Partition Manager
+text: |
+ The Classic API shall provide an interface to the Partition Manager.
type: interface
diff --git a/spec/if/rtems/ratemon/group.yml b/spec/if/rtems/ratemon/group.yml
index 67349d49..32ca9283 100644
--- a/spec/if/rtems/ratemon/group.yml
+++ b/spec/if/rtems/ratemon/group.yml
@@ -1,13 +1,13 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
The Rate-Monotonic Manager provides facilities to implement tasks which
execute in a periodic fashion. Critically, it also gathers information about
the execution of those periods and can provide important statistics to the
user which can be used to analyze and tune the application.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicRatemon
interface-type: group
@@ -17,4 +17,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Rate-Monotonic Manager
+text: |
+ The Classic API shall provide an interface to the Rate-Monotonic Manager.
type: interface
diff --git a/spec/if/rtems/region/group.yml b/spec/if/rtems/region/group.yml
index c4aba21c..4a058ea8 100644
--- a/spec/if/rtems/region/group.yml
+++ b/spec/if/rtems/region/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Region Manager provides facilities to dynamically allocate memory in
+ variable sized units.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Region Manager provides facilities to dynamically allocate memory in
- variable sized units.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicRegion
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Region Manager
+text: |
+ The Classic API shall provide an interface to the Region Manager.
type: interface
diff --git a/spec/if/rtems/sem/group.yml b/spec/if/rtems/sem/group.yml
index ec354faf..a0ad76f4 100644
--- a/spec/if/rtems/sem/group.yml
+++ b/spec/if/rtems/sem/group.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- The semaphore manager utilizes standard Dijkstra counting semaphores to
+ The Semaphore Manager utilizes standard Dijkstra counting semaphores to
provide synchronization and mutual exclusion capabilities.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
@@ -14,4 +14,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Semaphore Manager
+text: |
+ The Classic API shall provide an interface to the Semaphore Manager.
type: interface
diff --git a/spec/if/rtems/signal/group.yml b/spec/if/rtems/signal/group.yml
index 64d7285b..3c1719e0 100644
--- a/spec/if/rtems/signal/group.yml
+++ b/spec/if/rtems/signal/group.yml
@@ -1,11 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Signal Manager provides the capabilities required for asynchronous
+ communication.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Signal Manager provides the capabilities required for asynchronous
- communication.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicSignal
interface-type: group
@@ -15,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Signal Manager
+text: |
+ The Classic API shall provide an interface to the Signal Manager.
type: interface
diff --git a/spec/if/rtems/status/group.yml b/spec/if/rtems/status/group.yml
index c9184a10..b3c8a9e2 100644
--- a/spec/if/rtems/status/group.yml
+++ b/spec/if/rtems/status/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains the Classic API status codes and support functions.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Classic API status codes and support functions.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicStatus
interface-type: group
@@ -12,5 +12,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
-name: Status Codes
+name: Directive Status Codes
+text: |
+ The Classic API shall provide an interface to directive status codes.
type: interface
diff --git a/spec/if/rtems/support/group.yml b/spec/if/rtems/support/group.yml
index b0b9d831..dac46e84 100644
--- a/spec/if/rtems/support/group.yml
+++ b/spec/if/rtems/support/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ Items of this group should move to other groups.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- Items of this group should move to other groups.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicSupport
interface-type: group
@@ -14,4 +14,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Support Services
+text: |
+ The Classic API should not provide this interface part.
type: interface
diff --git a/spec/if/rtems/tasks/group.yml b/spec/if/rtems/tasks/group.yml
index 68968d04..d3ee1d29 100644
--- a/spec/if/rtems/tasks/group.yml
+++ b/spec/if/rtems/tasks/group.yml
@@ -1,9 +1,11 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Task Manager provides a comprehensive set of directives to create,
+ delete, and administer tasks.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the Task Manager API.
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicTasks
interface-type: group
@@ -13,4 +15,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Task Manager
+text: |
+ The Classic API shall provide an interface to the Task Manager.
type: interface
diff --git a/spec/if/rtems/timer/group.yml b/spec/if/rtems/timer/group.yml
index 8e874d96..bfccfeec 100644
--- a/spec/if/rtems/timer/group.yml
+++ b/spec/if/rtems/timer/group.yml
@@ -1,10 +1,10 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ The Timer Manager provides support for timer facilities.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
- The Timer Manager provides support for timer facilities.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicTimer
interface-type: group
@@ -14,4 +14,6 @@ links:
- role: interface-ingroup
uid: ../group
name: Timer Manager
+text: |
+ The Classic API shall provide an interface to the Timer Manager.
type: interface
diff --git a/spec/if/rtems/types/group.yml b/spec/if/rtems/types/group.yml
index 6eccbfae..d7a1aa7f 100644
--- a/spec/if/rtems/types/group.yml
+++ b/spec/if/rtems/types/group.yml
@@ -1,9 +1,9 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
+brief: |
+ This group contains basic types of the Classic API.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-description: |
- This group contains the general Classic API types.
+description: null
enabled-by: true
identifier: RTEMSAPIClassicTypes
interface-type: group
@@ -12,5 +12,7 @@ links:
uid: header
- role: interface-ingroup
uid: ../group
-name: Types
+name: Basic Types
+text: |
+ The Classic API shall provide an interface to basic types.
type: interface
diff --git a/spec/if/rtems/userext/group.yml b/spec/if/rtems/userext/group.yml
index cfa1ed9a..827b234d 100644
--- a/spec/if/rtems/userext/group.yml
+++ b/spec/if/rtems/userext/group.yml
@@ -1,12 +1,12 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: API
-copyrights:
-- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
-- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-description: |
+brief: |
The User Extensions Manager allows the application developer to augment the
executive by allowing them to supply extension routines which are invoked at
critical system events.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+description: null
enabled-by: true
identifier: RTEMSAPIClassicUserext
interface-type: group
@@ -16,4 +16,6 @@ links:
- role: interface-ingroup
uid: ../group
name: User Extensions Manager
+text: |
+ The Classic API shall provide an interface to the User Extensions Manager.
type: interface
diff --git a/spec/spec/interface-group.yml b/spec/spec/interface-group.yml
index 8710d42a..745d6017 100644
--- a/spec/spec/interface-group.yml
+++ b/spec/spec/interface-group.yml
@@ -27,6 +27,10 @@ spec-info:
description: |
It shall be the human readable name of the interface group.
spec-type: str
+ text:
+ description: |
+ It shall state the requirement for the interface group.
+ spec-type: requirement-text
description: |
This set of attributes specifies an interface group.
mandatory-attributes: all