[rtems-central commit] spec: Add scheduler glossary terms

[Sebastian Huber]

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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Apr 12 11:45:33 2021 +0200

spec: Add scheduler glossary terms

---

 spec-glossary/glossary/scheduler-eligible.yml   | 13 +++++++++++++
 spec-glossary/glossary/scheduler-helping.yml    | 14 ++++++++++++++
 spec-glossary/glossary/scheduler-home.yml       | 15 +++++++++++++++
 spec-glossary/glossary/scheduler-ineligible.yml | 13 +++++++++++++
 spec-glossary/glossary/scheduler.yml            |  5 +++++
 5 files changed, 60 insertions(+)

diff --git a/spec-glossary/glossary/scheduler-eligible.yml b/spec-glossary/glossary/scheduler-eligible.yml
new file mode 100644
index 0000000..88c71ef
--- /dev/null
+++ b/spec-glossary/glossary/scheduler-eligible.yml
@@ -0,0 +1,13 @@
+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 scheduler
+text: |
+  An eligible scheduler of a ${task:/term} is a ${scheduler:/term} which can be
+  used by the task to allocate a processor for the task.
+type: glossary
diff --git a/spec-glossary/glossary/scheduler-helping.yml b/spec-glossary/glossary/scheduler-helping.yml
new file mode 100644
index 0000000..8419e7d
--- /dev/null
+++ b/spec-glossary/glossary/scheduler-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 scheduler
+text: |
+  A helping scheduler of a ${task:/term} is a ${scheduler:/term} which is a
+  ${scheduler-eligible:/term} and which is not the ${scheduler-home:/term} of
+  the task.
+type: glossary
diff --git a/spec-glossary/glossary/scheduler-home.yml b/spec-glossary/glossary/scheduler-home.yml
new file mode 100644
index 0000000..71e8926
--- /dev/null
+++ b/spec-glossary/glossary/scheduler-home.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: home scheduler
+text: |
+  The home scheduler of a ${task:/term} is a ${scheduler:/term} which is a
+  ${scheduler-eligible:/term} and which is assigned to the task during the
+  initialization or explicitly via a directive call such as
+  ${/rtems/task/if/set-scheduler:/name}.
+type: glossary
diff --git a/spec-glossary/glossary/scheduler-ineligible.yml b/spec-glossary/glossary/scheduler-ineligible.yml
new file mode 100644
index 0000000..29ecd3b
--- /dev/null
+++ b/spec-glossary/glossary/scheduler-ineligible.yml
@@ -0,0 +1,13 @@
+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: ineligible scheduler
+text: |
+  An ineligible scheduler of a ${task:/term} is a ${scheduler:/term} which is
+  not an ${scheduler-eligible:/term}.
+type: glossary
diff --git a/spec-glossary/glossary/scheduler.yml b/spec-glossary/glossary/scheduler.yml
index db18147..e2782c2 100644
--- a/spec-glossary/glossary/scheduler.yml
+++ b/spec-glossary/glossary/scheduler.yml
@@ -14,4 +14,9 @@ text: |
   out of the set of ready tasks.  One method is to assign each task a
   priority number and assign the tasks with the lowest priority number to
   one processor of the set of processors owned by a scheduler instance.
+
+  A scheduler is either an ${scheduler-eligible:/term} or a
+  ${scheduler-ineligible:/term} for a task.  An ${scheduler-eligible:/term} is
+  either the ${scheduler-home:/term} or a ${scheduler-helping:/term} for a
+  task.
 type: glossary