diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-05 14:41:19 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-08 21:58:56 +0200 |
commit | bd08299d4394ca5d9ea686e6ae9157301b09b9ce (patch) | |
tree | 1d8d6e6db5e4b830ad34093193e96076934e5022 /spec/rtems | |
parent | spec: Add constraint to C interfaces (diff) | |
download | rtems-central-bd08299d4394ca5d9ea686e6ae9157301b09b9ce.tar.bz2 |
spec: Reorganize glossary
Diffstat (limited to 'spec/rtems')
39 files changed, 75 insertions, 36 deletions
diff --git a/spec/rtems/message/glossary/firstmessage.yml b/spec/rtems/message/glossary/firstmessage.yml index 139850b8..e1df7f99 100644 --- a/spec/rtems/message/glossary/firstmessage.yml +++ b/spec/rtems/message/glossary/firstmessage.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: first message text: | Messages are stored - and kept - in a ${/glossary/messagequeue:/term} diff --git a/spec/rtems/message/glossary/group.yml b/spec/rtems/message/glossary/group.yml new file mode 100644 index 00000000..d8f41a5b --- /dev/null +++ b/spec/rtems/message/glossary/group.yml @@ -0,0 +1,13 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +copyrights: +- Copyright (C) 2022 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: group +links: +- role: requirement-refinement + uid: /glossary-general +name: Message Manager +text: | + The system shall have a glossary for terms used specifically by the + ${../if/group:/name}. +type: glossary diff --git a/spec/rtems/message/glossary/lastmessage.yml b/spec/rtems/message/glossary/lastmessage.yml index b63fe803..20f4d05e 100644 --- a/spec/rtems/message/glossary/lastmessage.yml +++ b/spec/rtems/message/glossary/lastmessage.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: last message text: | See ${../glossary/firstmessage:/term}. diff --git a/spec/rtems/message/glossary/maximummessagesize.yml b/spec/rtems/message/glossary/maximummessagesize.yml index 9e0afb22..8e6cf641 100644 --- a/spec/rtems/message/glossary/maximummessagesize.yml +++ b/spec/rtems/message/glossary/maximummessagesize.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: maximum message size text: | The maximum message size is different for each diff --git a/spec/rtems/message/glossary/maximumpendingmessages.yml b/spec/rtems/message/glossary/maximumpendingmessages.yml index c7702895..cad17ab8 100644 --- a/spec/rtems/message/glossary/maximumpendingmessages.yml +++ b/spec/rtems/message/glossary/maximumpendingmessages.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: maximum pending messages text: | The maximum of pending messages is different for each diff --git a/spec/rtems/message/glossary/nop.yml b/spec/rtems/message/glossary/nop.yml index 372e356b..db19dc6d 100644 --- a/spec/rtems/message/glossary/nop.yml +++ b/spec/rtems/message/glossary/nop.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: Nop text: | Nop means *no operation*. This term is used when directives do not return diff --git a/spec/rtems/message/glossary/receiver.yml b/spec/rtems/message/glossary/receiver.yml index d2e2fb3b..821dc496 100644 --- a/spec/rtems/message/glossary/receiver.yml +++ b/spec/rtems/message/glossary/receiver.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: receiver text: | In this particular case, *receiver* shall be a ${/glossary/task:/term} diff --git a/spec/rtems/message/glossary/unblock.yml b/spec/rtems/message/glossary/unblock.yml index 69410c12..78631f40 100644 --- a/spec/rtems/message/glossary/unblock.yml +++ b/spec/rtems/message/glossary/unblock.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: unblock text: | Given a ${/glossary/task:/term} which has invoked an diff --git a/spec/rtems/ratemon/glossary/active.yml b/spec/rtems/ratemon/glossary/active.yml index 036d7bbe..ee59617a 100644 --- a/spec/rtems/ratemon/glossary/active.yml +++ b/spec/rtems/ratemon/glossary/active.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: active text: | A period is in active ${../glossary/state:/term} if a time diff --git a/spec/rtems/ratemon/glossary/consumed.yml b/spec/rtems/ratemon/glossary/consumed.yml index 9c0c1c4f..7554ddaa 100644 --- a/spec/rtems/ratemon/glossary/consumed.yml +++ b/spec/rtems/ratemon/glossary/consumed.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: consumed text: | Consumed denotes the processor ${../glossary/cputime:/term} consumed by the diff --git a/spec/rtems/ratemon/glossary/cputime.yml b/spec/rtems/ratemon/glossary/cputime.yml index 5687b49d..334cecb0 100644 --- a/spec/rtems/ratemon/glossary/cputime.yml +++ b/spec/rtems/ratemon/glossary/cputime.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: CPU time text: | An amount of time during which a processor executed the diff --git a/spec/rtems/ratemon/glossary/deadline.yml b/spec/rtems/ratemon/glossary/deadline.yml index 29bae547..09ea11f0 100644 --- a/spec/rtems/ratemon/glossary/deadline.yml +++ b/spec/rtems/ratemon/glossary/deadline.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: deadline text: | A deadline is a point in time. A sequence of deadlines each separated diff --git a/spec/rtems/ratemon/glossary/elapsed.yml b/spec/rtems/ratemon/glossary/elapsed.yml index 47c454e3..dd413899 100644 --- a/spec/rtems/ratemon/glossary/elapsed.yml +++ b/spec/rtems/ratemon/glossary/elapsed.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: elapsed text: | Elapsed denotes the real ${../glossary/time:/term} passed since the last diff --git a/spec/rtems/ratemon/glossary/expired.yml b/spec/rtems/ratemon/glossary/expired.yml index 9b6db30b..d3a74753 100644 --- a/spec/rtems/ratemon/glossary/expired.yml +++ b/spec/rtems/ratemon/glossary/expired.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: expired text: | A period is in expired ${../glossary/state:/term} if an diff --git a/spec/rtems/ratemon/glossary/group.yml b/spec/rtems/ratemon/glossary/group.yml new file mode 100644 index 00000000..6360d9bf --- /dev/null +++ b/spec/rtems/ratemon/glossary/group.yml @@ -0,0 +1,13 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +copyrights: +- Copyright (C) 2022 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: group +links: +- role: requirement-refinement + uid: /glossary-general +name: Rate-Monotonic Manager +text: | + The system shall have a glossary for terms used specifically by the + ${../if/group:/name}. +type: glossary diff --git a/spec/rtems/ratemon/glossary/inactive.yml b/spec/rtems/ratemon/glossary/inactive.yml index 3ec97eed..4447043a 100644 --- a/spec/rtems/ratemon/glossary/inactive.yml +++ b/spec/rtems/ratemon/glossary/inactive.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: inactive text: | A period is in inactive ${../glossary/state:/term} if no current diff --git a/spec/rtems/ratemon/glossary/interval.yml b/spec/rtems/ratemon/glossary/interval.yml index 711f5f69..6e9dfc36 100644 --- a/spec/rtems/ratemon/glossary/interval.yml +++ b/spec/rtems/ratemon/glossary/interval.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: interval text: | The current interval starts with the last return from a successful call to diff --git a/spec/rtems/ratemon/glossary/job.yml b/spec/rtems/ratemon/glossary/job.yml index cdff78f6..ed56dd8e 100644 --- a/spec/rtems/ratemon/glossary/job.yml +++ b/spec/rtems/ratemon/glossary/job.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: job text: | A job denotes the code which the ${../glossary/ownertask:/term} executes diff --git a/spec/rtems/ratemon/glossary/nop.yml b/spec/rtems/ratemon/glossary/nop.yml index 372e356b..db19dc6d 100644 --- a/spec/rtems/ratemon/glossary/nop.yml +++ b/spec/rtems/ratemon/glossary/nop.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: Nop text: | Nop means *no operation*. This term is used when directives do not return diff --git a/spec/rtems/ratemon/glossary/ownertask.yml b/spec/rtems/ratemon/glossary/ownertask.yml index 10042c35..59b4353a 100644 --- a/spec/rtems/ratemon/glossary/ownertask.yml +++ b/spec/rtems/ratemon/glossary/ownertask.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: owner task text: | The owner ${/glossary/task:/term} of a period is the ${/glossary/task:/term} diff --git a/spec/rtems/ratemon/glossary/postponedjob.yml b/spec/rtems/ratemon/glossary/postponedjob.yml index b16e32f3..173d4615 100644 --- a/spec/rtems/ratemon/glossary/postponedjob.yml +++ b/spec/rtems/ratemon/glossary/postponedjob.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: postponed job text: | A postponed job is a ${../glossary/job:/term} which should already have been diff --git a/spec/rtems/ratemon/glossary/scheduleroperation.yml b/spec/rtems/ratemon/glossary/scheduleroperation.yml index 6d5d7602..7b364492 100644 --- a/spec/rtems/ratemon/glossary/scheduleroperation.yml +++ b/spec/rtems/ratemon/glossary/scheduleroperation.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: scheduler operation text: | When the ${../glossary/ownertask:/term} executes a ${../glossary/job:/term} of diff --git a/spec/rtems/ratemon/glossary/state.yml b/spec/rtems/ratemon/glossary/state.yml index b7ee8235..6aa04bd5 100644 --- a/spec/rtems/ratemon/glossary/state.yml +++ b/spec/rtems/ratemon/glossary/state.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: state text: | The rate monotonic state indicates whether the period is currently used to diff --git a/spec/rtems/ratemon/glossary/time.yml b/spec/rtems/ratemon/glossary/time.yml index bb47b0ae..ee491b26 100644 --- a/spec/rtems/ratemon/glossary/time.yml +++ b/spec/rtems/ratemon/glossary/time.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: time text: | An amount of real time which passed. diff --git a/spec/rtems/timer/glossary/clock.yml b/spec/rtems/timer/glossary/clock.yml index 9d194cb8..82ae1f27 100644 --- a/spec/rtems/timer/glossary/clock.yml +++ b/spec/rtems/timer/glossary/clock.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: clock text: | The timer clock denotes the clock used to determine when the timer will diff --git a/spec/rtems/timer/glossary/context.yml b/spec/rtems/timer/glossary/context.yml index 31b30805..179e2ccc 100644 --- a/spec/rtems/timer/glossary/context.yml +++ b/spec/rtems/timer/glossary/context.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: context text: | The timer context denotes whether the ${../glossary/timerserviceroutine:/term} diff --git a/spec/rtems/timer/glossary/fire.yml b/spec/rtems/timer/glossary/fire.yml index f0d34f74..4d863dcd 100644 --- a/spec/rtems/timer/glossary/fire.yml +++ b/spec/rtems/timer/glossary/fire.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: fire text: | A timer fires when ${/glossary/rtems:/term} in an ${/glossary/interrupt:/term} diff --git a/spec/rtems/timer/glossary/group.yml b/spec/rtems/timer/glossary/group.yml new file mode 100644 index 00000000..41507612 --- /dev/null +++ b/spec/rtems/timer/glossary/group.yml @@ -0,0 +1,13 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 +copyrights: +- Copyright (C) 2022 embedded brains GmbH (http://www.embedded-brains.de) +enabled-by: true +glossary-type: group +links: +- role: requirement-refinement + uid: /glossary-general +name: Timer Manager +text: | + The system shall have a glossary for terms used specifically by the + ${../if/group:/name}. +type: glossary diff --git a/spec/rtems/timer/glossary/inactive.yml b/spec/rtems/timer/glossary/inactive.yml index 1976578d..c197fba8 100644 --- a/spec/rtems/timer/glossary/inactive.yml +++ b/spec/rtems/timer/glossary/inactive.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: inactive text: | A timer in inactive ${../glossary/state:/term} will not diff --git a/spec/rtems/timer/glossary/interruptcontext.yml b/spec/rtems/timer/glossary/interruptcontext.yml index 84d44afb..033c76ad 100644 --- a/spec/rtems/timer/glossary/interruptcontext.yml +++ b/spec/rtems/timer/glossary/interruptcontext.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: interrupt context text: | The ${../glossary/timerserviceroutine:/term} is or will be executed as part of diff --git a/spec/rtems/timer/glossary/none.yml b/spec/rtems/timer/glossary/none.yml index be81c69f..1c5b62bf 100644 --- a/spec/rtems/timer/glossary/none.yml +++ b/spec/rtems/timer/glossary/none.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: none text: | A timer in ${../glossary/state:/term} or ${../glossary/context:/term} none or diff --git a/spec/rtems/timer/glossary/nop.yml b/spec/rtems/timer/glossary/nop.yml index 362f966b..8878784a 100644 --- a/spec/rtems/timer/glossary/nop.yml +++ b/spec/rtems/timer/glossary/nop.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: Nop text: | Nop means *no operation*. This term is used when directives do not return diff --git a/spec/rtems/timer/glossary/pending.yml b/spec/rtems/timer/glossary/pending.yml index 3bb93efc..6f2e5534 100644 --- a/spec/rtems/timer/glossary/pending.yml +++ b/spec/rtems/timer/glossary/pending.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: pending text: | The timers in ${../glossary/servercontext:/term} have a third diff --git a/spec/rtems/timer/glossary/realtimeclock.yml b/spec/rtems/timer/glossary/realtimeclock.yml index 72c6a32d..23def5ab 100644 --- a/spec/rtems/timer/glossary/realtimeclock.yml +++ b/spec/rtems/timer/glossary/realtimeclock.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: realtime clock text: | The timer uses ${/glossary/clock-realtime:/term} to determine the point in diff --git a/spec/rtems/timer/glossary/scheduled.yml b/spec/rtems/timer/glossary/scheduled.yml index dfcaacc1..e6bf1f22 100644 --- a/spec/rtems/timer/glossary/scheduled.yml +++ b/spec/rtems/timer/glossary/scheduled.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: scheduled text: | A timer in scheduled ${../glossary/state:/term} is set to diff --git a/spec/rtems/timer/glossary/servercontext.yml b/spec/rtems/timer/glossary/servercontext.yml index 2e442bf7..29a3bcae 100644 --- a/spec/rtems/timer/glossary/servercontext.yml +++ b/spec/rtems/timer/glossary/servercontext.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: server context text: | The ${../glossary/timerserviceroutine:/term} is or will be executed by the ${/glossary/task:/term} of the timer server. A timer enters server ${../glossary/context:/term} when the timer is ${../glossary/scheduled:/term} using the directives ${../if/server-fire-after:/name} or ${../if/server-fire-when:/name}. A timer leaves server ${../glossary/context:/term} when the timer is ${../glossary/scheduled:/term} using the directives ${../if/fire-after:/name} or ${../if/fire-when:/name} or when the timer is deleted. Canceling or resetting a timer does not change the ${../glossary/context:/term}. diff --git a/spec/rtems/timer/glossary/state.yml b/spec/rtems/timer/glossary/state.yml index 10c10606..cfc48df6 100644 --- a/spec/rtems/timer/glossary/state.yml +++ b/spec/rtems/timer/glossary/state.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: state text: | The state of a timer denotes whether the timer is set to ${../glossary/fire:/term} or not. There is also a third state for the timer has fired but the ${../glossary/timerserviceroutine:/term} has not been invoked yet. A timer can be in one of these states: diff --git a/spec/rtems/timer/glossary/ticksbasedclock.yml b/spec/rtems/timer/glossary/ticksbasedclock.yml index bd8f0628..e52b9918 100644 --- a/spec/rtems/timer/glossary/ticksbasedclock.yml +++ b/spec/rtems/timer/glossary/ticksbasedclock.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: ticks based clock text: | The timer uses the ${/glossary/tick:/term} based ${../glossary/clock:/term} to determine the point in time to ${../glossary/fire:/term}. A timer is associated with ${/glossary/tick:/term} based ${../glossary/clock:/term} when the timer is ${../glossary/scheduled:/term} using the directives ${../if/fire-after:/name} or ${../if/server-fire-after:/name}. A timer is not longer associated with the ${/glossary/tick:/term} based ${../glossary/clock:/term} when the timer is ${../glossary/scheduled:/term} using the directives ${../if/fire-when:/name} or ${../if/server-fire-when:/name} or when the timer is deleted. Canceling or resetting a timer does not change the association with a particular ${../glossary/clock:/term}. diff --git a/spec/rtems/timer/glossary/timerserviceroutine.yml b/spec/rtems/timer/glossary/timerserviceroutine.yml index 8e6bd0c2..9008ce5a 100644 --- a/spec/rtems/timer/glossary/timerserviceroutine.yml +++ b/spec/rtems/timer/glossary/timerserviceroutine.yml @@ -5,7 +5,7 @@ enabled-by: true glossary-type: term links: - role: glossary-member - uid: /glossary-requirements + uid: group term: Timer Service Routine text: | The timer service routine is a user defined function executed when or after the timer fires (see ${../glossary/fire:/term}). The user must provide a reference to the timer service routine when scheduling a timer. See also ${../glossary/scheduled:/term}. |