summaryrefslogtreecommitdiffstats
path: root/c-user/config/scheduler-general.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-10-12 15:51:24 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-09 15:04:34 +0100
commit51a5138bfea0c1bebfa25ba9e726f52589f3c21a (patch)
tree59bfb31a847d2bde43ed4f8a4e73de920b291150 /c-user/config/scheduler-general.rst
parentf6102914ebcfffd41eea32c214c61d32f1cd9fb3 (diff)
downloadrtems-docs-51a5138bfea0c1bebfa25ba9e726f52589f3c21a.tar.bz2
c-user: Add "Generated from ..." comments
Diffstat (limited to 'c-user/config/scheduler-general.rst')
-rw-r--r--c-user/config/scheduler-general.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 8c60a96..2916cf7 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -16,6 +16,8 @@
..
.. https://docs.rtems.org/branches/master/eng/req/howto.html
+.. Generated from spec:/acfg/if/group-schedgeneral
+
General Scheduler Configuration
===============================
@@ -42,6 +44,8 @@ The pluggable scheduler interface also enables the user to provide their own
scheduling algorithm. If you choose to do this, you must define multiple
configuration option.
+.. Generated from spec:/acfg/if/cbs-max-servers
+
.. index:: CONFIGURE_CBS_MAXIMUM_SERVERS
.. _CONFIGURE_CBS_MAXIMUM_SERVERS:
@@ -78,6 +82,8 @@ NOTES:
This configuration option is only evaluated if the configuration option
:ref:`CONFIGURE_SCHEDULER_CBS` is defined.
+.. Generated from spec:/acfg/if/max-priority
+
.. index:: CONFIGURE_MAXIMUM_PRIORITY
.. index:: maximum priority
.. index:: number of priority levels
@@ -136,6 +142,8 @@ NOTES:
The default value is 255, because RTEMS shall support 256 priority levels to
be compliant with various standards. These priorities range from 0 to 255.
+.. Generated from spec:/acfg/if/scheduler-assignments
+
.. index:: CONFIGURE_SCHEDULER_ASSIGNMENTS
.. _CONFIGURE_SCHEDULER_ASSIGNMENTS:
@@ -177,6 +185,8 @@ NOTES:
This is an advanced configuration option, see
:ref:`ConfigurationSchedulersClustered`.
+.. Generated from spec:/acfg/if/scheduler-cbs
+
.. index:: CONFIGURE_SCHEDULER_CBS
.. _CONFIGURE_SCHEDULER_CBS:
@@ -206,6 +216,8 @@ NOTES:
In case no explicit :ref:`ConfigurationSchedulersClustered`
is present, then it is used as the scheduler for exactly one processor.
+.. Generated from spec:/acfg/if/scheduler-edf
+
.. index:: CONFIGURE_SCHEDULER_EDF
.. _CONFIGURE_SCHEDULER_EDF:
@@ -235,6 +247,8 @@ NOTES:
In case no explicit :ref:`ConfigurationSchedulersClustered`
is present, then it is used as the scheduler for exactly one processor.
+.. Generated from spec:/acfg/if/scheduler-edf-smp
+
.. index:: CONFIGURE_SCHEDULER_EDF_SMP
.. _CONFIGURE_SCHEDULER_EDF_SMP:
@@ -271,6 +285,8 @@ NOTES:
:ref:`CONFIGURE_MAXIMUM_PROCESSORS` is
greater than one.
+.. Generated from spec:/acfg/if/scheduler-name
+
.. index:: CONFIGURE_SCHEDULER_NAME
.. _CONFIGURE_SCHEDULER_NAME:
@@ -319,6 +335,8 @@ NOTES:
Use :c:func:`rtems_build_name` to define the scheduler name.
+.. Generated from spec:/acfg/if/scheduler-priority
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY
.. _CONFIGURE_SCHEDULER_PRIORITY:
@@ -355,6 +373,8 @@ NOTES:
The memory allocated for this scheduler depends on the
:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+.. Generated from spec:/acfg/if/scheduler-priority-affinity-smp
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP
.. _CONFIGURE_SCHEDULER_PRIORITY_AFFINITY_SMP:
@@ -390,6 +410,8 @@ NOTES:
The memory allocated for this scheduler depends on the
:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+.. Generated from spec:/acfg/if/scheduler-priority-smp
+
.. index:: CONFIGURE_SCHEDULER_PRIORITY_SMP
.. _CONFIGURE_SCHEDULER_PRIORITY_SMP:
@@ -425,6 +447,8 @@ NOTES:
The memory allocated for this scheduler depends on the
:ref:`CONFIGURE_MAXIMUM_PRIORITY` configuration option.
+.. Generated from spec:/acfg/if/scheduler-simple
+
.. index:: CONFIGURE_SCHEDULER_SIMPLE
.. _CONFIGURE_SCHEDULER_SIMPLE:
@@ -454,6 +478,8 @@ NOTES:
In case no explicit :ref:`ConfigurationSchedulersClustered`
is present, then it is used as the scheduler for exactly one processor.
+.. Generated from spec:/acfg/if/scheduler-simple-smp
+
.. index:: CONFIGURE_SCHEDULER_SIMPLE_SMP
.. _CONFIGURE_SCHEDULER_SIMPLE_SMP:
@@ -487,6 +513,8 @@ NOTES:
In case no explicit :ref:`ConfigurationSchedulersClustered`
is present, then it is used as the scheduler for up to 32 processors.
+.. Generated from spec:/acfg/if/scheduler-strong-apa
+
.. index:: CONFIGURE_SCHEDULER_STRONG_APA
.. _CONFIGURE_SCHEDULER_STRONG_APA:
@@ -517,6 +545,8 @@ NOTES:
This scheduler algorithm is not correctly implemented. Do not use it.
+.. Generated from spec:/acfg/if/scheduler-user
+
.. index:: CONFIGURE_SCHEDULER_USER
.. _CONFIGURE_SCHEDULER_USER: