summaryrefslogtreecommitdiffstats
path: root/spec/rtems/timer/glossary/realtimeclock.yml
diff options
context:
space:
mode:
authorFrank Kühndel <frank.kuehndel@embedded-brains.de>2021-05-03 11:54:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-05-17 06:45:11 +0200
commit8fa066874456be43fd758a35377ca0ce71cf83ca (patch)
tree4a85806d8eb6045c7b440fcdb4bfe95efb3760a9 /spec/rtems/timer/glossary/realtimeclock.yml
parentspec: Add spec item for rtems_timer_cancel() (diff)
downloadrtems-central-8fa066874456be43fd758a35377ca0ce71cf83ca.tar.bz2
spec: Glossary terms for timer manager
spec/rtems/timer/glossary/*.yml Here are the timer specific glossary terms. As requested, the manager specific terms are put into an own folder alongside the other specification files of the manager. spec/glossary-requirements.yml The glossary terms for specifications are in an own group *glossary-requirements* to keep them separate from the existing glossary terms (*glossary-general*).
Diffstat (limited to 'spec/rtems/timer/glossary/realtimeclock.yml')
-rw-r--r--spec/rtems/timer/glossary/realtimeclock.yml21
1 files changed, 21 insertions, 0 deletions
diff --git a/spec/rtems/timer/glossary/realtimeclock.yml b/spec/rtems/timer/glossary/realtimeclock.yml
new file mode 100644
index 00000000..72c6a32d
--- /dev/null
+++ b/spec/rtems/timer/glossary/realtimeclock.yml
@@ -0,0 +1,21 @@
+SPDX-License-Identifier: CC-BY-SA-4.0
+copyrights:
+- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+glossary-type: term
+links:
+- role: glossary-member
+ uid: /glossary-requirements
+term: realtime clock
+text: |
+ The timer uses ${/glossary/clock-realtime:/term} to determine the point in
+ time to ${../glossary/fire:/term}. A timer is associated with
+ ${/glossary/clock-realtime:/term} when the timer is
+ ${../glossary/scheduled:/term} using the directives ${../if/fire-when:/name}
+ or ${../if/server-fire-when:/name}. A timer is not longer associated with
+ ${/glossary/clock-realtime:/term} when the timer is
+ ${../glossary/scheduled:/term} using the directives ${../if/fire-after:/name}
+ or ${../if/server-fire-after:/name} or when the timer is deleted. Canceling or
+ resetting a timer does not change the association with a particular
+ ${../glossary/clock:/term}.
+type: glossary