summaryrefslogtreecommitdiffstats
path: root/c-user/config/classic-init-task.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-18 16:50:00 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-24 07:48:21 +0100
commitdfe0ec05b9c06e7dc915788e24c74582f51791f9 (patch)
tree627bc13ac8c3b148beeb9270c7681f465224e827 /c-user/config/classic-init-task.rst
parentposix-compliance: Add some missing methods (diff)
downloadrtems-docs-dfe0ec05b9c06e7dc915788e24c74582f51791f9.tar.bz2
c-user: Use new template for feature config opts
Try to bring all descriptions up to date. Add cross-references to several options. Close #3900.
Diffstat (limited to 'c-user/config/classic-init-task.rst')
-rw-r--r--c-user/config/classic-init-task.rst35
1 files changed, 16 insertions, 19 deletions
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
index 8eaafca..8addf9f 100644
--- a/c-user/config/classic-init-task.rst
+++ b/c-user/config/classic-init-task.rst
@@ -206,28 +206,25 @@ CONFIGURE_RTEMS_INIT_TASKS_TABLE
CONSTANT:
``CONFIGURE_RTEMS_INIT_TASKS_TABLE``
-DATA TYPE:
- Boolean feature macro.
-
-RANGE:
- Defined or undefined.
+OPTION TYPE:
+ This configuration option is a boolean feature define.
-DEFAULT VALUE:
- This is not defined by default.
+DEFAULT CONFIGURATION:
+ If this configuration option is undefined, then the described feature is not
+ enabled.
DESCRIPTION:
- ``CONFIGURE_RTEMS_INIT_TASKS_TABLE`` is defined if the user wishes to use a
- Classic RTEMS API Initialization Task Table. The table built by
- ``<rtems/confdefs.h>`` specifies the parameters for a single task. This is
- sufficient for applications which initialization the system from a single
- task.
-
- By default, this field is not defined as the user MUST select their own API
- for initialization tasks.
+ In case this configuration option is defined, then exactly one Classic API
+ initialization task is configured.
NOTES:
- The application may choose to use the initialization tasks or threads table
- from another API.
+ The application must define exactly one of the following configuration
+ options
+
+ * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+
+ * :ref:`CONFIGURE_POSIX_INIT_THREAD_TABLE`, or
+
+ * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
- A compile time error will be generated if the user does not configure any
- initialization tasks or threads.
+ otherwise a compile time error in the configuration file will occur.