summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-06 10:01:12 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-06 10:06:09 +0200
commitd2d60c54e99d1b80a487b84abcf15cea4972a49c (patch)
treec2ce0e4afb53d77eb54347b760acfd6bd8b4009c
parentReflect removal of the epiphany target (diff)
downloadrtems-docs-d2d60c54e99d1b80a487b84abcf15cea4972a49c.tar.bz2
c-user: Sort appl config options by name
-rw-r--r--c-user/config/bdbuf.rst38
-rw-r--r--c-user/config/mpci.rst56
-rw-r--r--c-user/config/task-stack-alloc.rst50
3 files changed, 72 insertions, 72 deletions
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 604f887..79459bf 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -319,55 +319,55 @@ DESCRIPTION:
NOTES:
None.
-.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
+.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
-.. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
+.. _CONFIGURE_SWAPOUT_WORKER_TASKS:
-CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
---------------------------------------
+CONFIGURE_SWAPOUT_WORKER_TASKS
+------------------------------
CONSTANT:
- ``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
+ ``CONFIGURE_SWAPOUT_WORKER_TASKS``
OPTION TYPE:
This configuration option is an integer define.
DEFAULT VALUE:
- The default value is 15.
+ The default value is 0.
VALUE CONSTRAINTS:
- The value of this configuration option shall be a valid Classic API task
- priority. The set of valid task priorities is scheduler-specific.
+ The value of this configuration option shall be greater than or equal to 0
+ and less than or equal to ``UINT32_MAX``.
DESCRIPTION:
- The value of this configuration option defines the swapout worker task
- priority.
+ The value of this configuration option defines the swapout worker task count.
NOTES:
None.
-.. index:: CONFIGURE_SWAPOUT_WORKER_TASKS
+.. index:: CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
-.. _CONFIGURE_SWAPOUT_WORKER_TASKS:
+.. _CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY:
-CONFIGURE_SWAPOUT_WORKER_TASKS
-------------------------------
+CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY
+--------------------------------------
CONSTANT:
- ``CONFIGURE_SWAPOUT_WORKER_TASKS``
+ ``CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY``
OPTION TYPE:
This configuration option is an integer define.
DEFAULT VALUE:
- The default value is 0.
+ The default value is 15.
VALUE CONSTRAINTS:
- The value of this configuration option shall be greater than or equal to 0
- and less than or equal to ``UINT32_MAX``.
+ The value of this configuration option shall be a valid Classic API task
+ priority. The set of valid task priorities is scheduler-specific.
DESCRIPTION:
- The value of this configuration option defines the swapout worker task count.
+ The value of this configuration option defines the swapout worker task
+ priority.
NOTES:
None.
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index 854600b..1413474 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -13,34 +13,6 @@ are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
is defined. The multiprocessing (MPCI) support must not be confused with the
SMP support.
-.. index:: CONFIGURE_MP_APPLICATION
-
-.. _CONFIGURE_MP_APPLICATION:
-
-CONFIGURE_MP_APPLICATION
-------------------------
-
-CONSTANT:
- ``CONFIGURE_MP_APPLICATION``
-
-OPTION TYPE:
- This configuration option is a boolean feature define.
-
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the multiprocessing services
- are not initialized.
-
-DESCRIPTION:
- This configuration option is defined to indicate that the application intends
- to be part of a multiprocessing configuration. Additional configuration
- options are assumed to be provided.
-
-NOTES:
- This configuration option shall be undefined if the multiprocessing support
- is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
- build configuration option). Otherwise a compile time error in the
- configuration file will occur.
-
.. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
.. _CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK:
@@ -78,6 +50,34 @@ NOTES:
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
+.. index:: CONFIGURE_MP_APPLICATION
+
+.. _CONFIGURE_MP_APPLICATION:
+
+CONFIGURE_MP_APPLICATION
+------------------------
+
+CONSTANT:
+ ``CONFIGURE_MP_APPLICATION``
+
+OPTION TYPE:
+ This configuration option is a boolean feature define.
+
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the multiprocessing services
+ are not initialized.
+
+DESCRIPTION:
+ This configuration option is defined to indicate that the application intends
+ to be part of a multiprocessing configuration. Additional configuration
+ options are assumed to be provided.
+
+NOTES:
+ This configuration option shall be undefined if the multiprocessing support
+ is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
+ build configuration option). Otherwise a compile time error in the
+ configuration file will occur.
+
.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
.. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS:
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 297c624..203757a 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -47,6 +47,31 @@ NOTES:
* :ref:`CONFIGURE_TASK_STACK_DEALLOCATOR`
+.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
+
+.. _CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE:
+
+CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
+------------------------------------------------
+
+CONSTANT:
+ ``CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE``
+
+OPTION TYPE:
+ This configuration option is a boolean feature define.
+
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
+
+DESCRIPTION:
+ In case this configuration option is defined, then the system is informed
+ that the task stack allocator does not use the RTEMS Workspace.
+
+NOTES:
+ This configuration option may be used if a custom task stack allocator is
+ configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
+
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_INIT
.. _CONFIGURE_TASK_STACK_ALLOCATOR_INIT:
@@ -146,28 +171,3 @@ DESCRIPTION:
NOTES:
This configuration option may be used if a custom task stack allocator is
configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.
-
-.. index:: CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
-
-.. _CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE:
-
-CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE
-------------------------------------------------
-
-CONSTANT:
- ``CONFIGURE_TASK_STACK_ALLOCATOR_AVOIDS_WORK_SPACE``
-
-OPTION TYPE:
- This configuration option is a boolean feature define.
-
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
-
-DESCRIPTION:
- In case this configuration option is defined, then the system is informed
- that the task stack allocator does not use the RTEMS Workspace.
-
-NOTES:
- This configuration option may be used if a custom task stack allocator is
- configured, see :ref:`CONFIGURE_TASK_STACK_ALLOCATOR`.