[rtems-central commit] glossary: Add priority terms

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed May 12 13:15:17 2021 +0200

glossary: Add priority terms

---

 spec-glossary/glossary/priority-current.yml  | 17 +++++++++++++++++
 spec-glossary/glossary/priority-eligible.yml | 15 +++++++++++++++
 spec-glossary/glossary/priority-helping.yml  | 14 ++++++++++++++
 spec-glossary/glossary/priority-real.yml     | 17 +++++++++++++++++
 spec-glossary/glossary/priority-task.yml     | 17 +++++++++++++++++
 spec-glossary/glossary/priority.yml          |  6 +++---
 6 files changed, 83 insertions(+), 3 deletions(-)

diff --git a/spec-glossary/glossary/priority-current.yml b/spec-glossary/glossary/priority-current.yml
new file mode 100644
index 0000000..af5a070
--- /dev/null
+++ b/spec-glossary/glossary/priority-current.yml
@@ -0,0 +1,17 @@
+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
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: current priority
+text: |
+  The current priority of a ${task:/term} is the ${priority-task:/term} with
+  respect to the ${scheduler-home:/term} of the task.  It is an aggregation of
+  the ${priority-real:/term} and temporary priority adjustments due to locking
+  protocols, the rate-monotonic period objects on some schedulers such as EDF,
+  and the ${posix:/term} sporadic server.  The current priority is an
+  ${priority-eligible:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/priority-eligible.yml b/spec-glossary/glossary/priority-eligible.yml
new file mode 100644
index 0000000..5c65926
--- /dev/null
+++ b/spec-glossary/glossary/priority-eligible.yml
@@ -0,0 +1,15 @@
+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
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: eligible priority
+text: |
+  An eligible priority of a ${task:/term} is the ${priority-task:/term} with
+  respect to the corresponding ${scheduler-eligible:/term} of the task.  An
+  eligible priority is either the ${priority-current:/term} or a
+  ${priority-helping:/term} of a task.
+type: glossary
diff --git a/spec-glossary/glossary/priority-helping.yml b/spec-glossary/glossary/priority-helping.yml
new file mode 100644
index 0000000..545b541
--- /dev/null
+++ b/spec-glossary/glossary/priority-helping.yml
@@ -0,0 +1,14 @@
+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
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: helping priority
+text: |
+  A helping priority of a ${task:/term} is the ${priority-task:/term} with
+  respect to the corresponding ${scheduler-helping:/term} of the task.  A
+  helping priority is an ${priority-eligible:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/priority-real.yml b/spec-glossary/glossary/priority-real.yml
new file mode 100644
index 0000000..1f6c7a0
--- /dev/null
+++ b/spec-glossary/glossary/priority-real.yml
@@ -0,0 +1,17 @@
+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
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: real priority
+text: |
+  Each ${task:/term} has exactly one real priority.  The real priority is
+  always with respect to the ${scheduler-home:/term} of a task.  It is defined
+  during task initialization.  It may be changed by directives such as
+  ${/rtems/task/if/set-priority:/name} and
+  ${/rtems/task/if/set-scheduler:/name}.  The real priority is the foundation
+  of the ${priority-current:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/priority-task.yml b/spec-glossary/glossary/priority-task.yml
new file mode 100644
index 0000000..b2bfccf
--- /dev/null
+++ b/spec-glossary/glossary/priority-task.yml
@@ -0,0 +1,17 @@
+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
+glossary-type: term
+links:
+- role: glossary-member
+  uid: ../glossary-general
+term: task priority
+text: |
+  A task priority of a ${task:/term} determines its importance relative to
+  other tasks.  The scheduler use task priorities to determine which
+  ${readytask:/term} gets a processor allocated, see ${scheduledtask:/term}.  The
+  ${priority-eligible:/plural} of a task define the position of the task in a
+  ${waitqueue:/term} which uses the priority discipline.  Each task has at
+  least the ${priority-real:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/priority.yml b/spec-glossary/glossary/priority.yml
index 67602ef..b5efb9d 100644
--- a/spec-glossary/glossary/priority.yml
+++ b/spec-glossary/glossary/priority.yml
@@ -8,7 +8,7 @@ links:
   uid: ../glossary-general
 term: priority
 text: |
-  A mechanism used to represent the relative importance of an element in a
-  set of items.  RTEMS uses priority to determine which task should
-  execute.
+  The priority is a mechanism used to represent the relative importance of an
+  element in a set of items.  RTEMS uses ${priority-task:/plural} to determine
+  which ${task:/term} should execute.
 type: glossary