summaryrefslogtreecommitdiffstats
path: root/c-user/config/posix-init-thread.rst
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-16 08:17:31 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-11-17 09:08:53 +0100
commit1c8ce332e273bb9f10cdb18e32e977cb9301fbad (patch)
tree8622528cf6fb748d6196ba5b9a46bf8c10b941bc /c-user/config/posix-init-thread.rst
parentc-user: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS (diff)
downloadrtems-docs-1c8ce332e273bb9f10cdb18e32e977cb9301fbad.tar.bz2
c-user: Use rubric for configuration options
Clear the page for each configuration options similar to the directives. Use a rubric instead of a definition list for the application configuration options similar to the directive documentation pages. For direcives and application configuration options use the same rubric order. Generalize value constraints to constraints. This patch does not change hand written content.
Diffstat (limited to 'c-user/config/posix-init-thread.rst')
-rw-r--r--c-user/config/posix-init-thread.rst127
1 files changed, 76 insertions, 51 deletions
diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst
index 8623f2c..c038ec8 100644
--- a/c-user/config/posix-init-thread.rst
+++ b/c-user/config/posix-init-thread.rst
@@ -28,6 +28,10 @@ initialization thread.
.. Generated from spec:/acfg/if/posix-init-thread-entry-point
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
.. _CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT:
@@ -35,29 +39,39 @@ initialization thread.
CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
---------------------------------------
-CONSTANT:
- ``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is an initializer define.
+
+.. rubric:: DEFAULT VALUE:
-OPTION TYPE:
- This configuration option is an initializer define.
+The default value is ``POSIX_Init``.
-DEFAULT VALUE:
- The default value is ``POSIX_Init``.
+.. rubric:: DESCRIPTION:
-VALUE CONSTRAINTS:
- The value of this configuration option shall be defined to a valid function
- pointer of the type ``void *( *entry_point )( void * )``.
+The value of this configuration option initializes the entry point of the
+POSIX API initialization thread.
-DESCRIPTION:
- The value of this configuration option initializes the entry point of the
- POSIX API initialization thread.
+.. rubric:: NOTES:
-NOTES:
- The application shall provide the function referenced by this configuration
- option.
+The application shall provide the function referenced by this configuration
+option.
+
+.. rubric:: CONSTRAINTS:
+
+The value of the configuration option shall be defined to a valid function
+pointer of the type ``void *( *entry_point )( void * )``.
.. Generated from spec:/acfg/if/posix-init-thread-stack-size
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
.. _CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE:
@@ -65,35 +79,41 @@ NOTES:
CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE
--------------------------------------
-CONSTANT:
- ``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE``
-OPTION TYPE:
- This configuration option is an integer define.
+.. rubric:: OPTION TYPE:
-DEFAULT VALUE:
- The default value is :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE`.
+This configuration option is an integer define.
-VALUE CONSTRAINTS:
- The value of this configuration option shall satisfy all of the following
- constraints:
+.. rubric:: DEFAULT VALUE:
- * It shall be greater than or equal to
- :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+The default value is :ref:`CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE`.
- * It shall be small enough so that the task stack space calculation carried
- out by ``<rtems/confdefs.h>`` does not overflow an integer of type
- `uintptr_t <https://en.cppreference.com/w/c/types/integer>`_.
+.. rubric:: DESCRIPTION:
-DESCRIPTION:
- The value of this configuration option defines the thread stack size of the
- POSIX API initialization thread.
+The value of this configuration option defines the thread stack size of the
+POSIX API initialization thread.
-NOTES:
- None.
+.. rubric:: CONSTRAINTS:
+
+The following constraints apply to this configuration option:
+
+* The value of the configuration option shall be greater than or equal to
+ :ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
+
+* The value of the configuration option shall be small enough so that the task
+ stack space calculation carried out by ``<rtems/confdefs.h>`` does not
+ overflow an integer of type `uintptr_t
+ <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/posix-init-thread-table
+.. raw:: latex
+
+ \clearpage
+
.. index:: CONFIGURE_POSIX_INIT_THREAD_TABLE
.. _CONFIGURE_POSIX_INIT_THREAD_TABLE:
@@ -101,28 +121,33 @@ NOTES:
CONFIGURE_POSIX_INIT_THREAD_TABLE
---------------------------------
-CONSTANT:
- ``CONFIGURE_POSIX_INIT_THREAD_TABLE``
+.. rubric:: CONSTANT:
+
+``CONFIGURE_POSIX_INIT_THREAD_TABLE``
+
+.. rubric:: OPTION TYPE:
+
+This configuration option is a boolean feature define.
+
+.. rubric:: DEFAULT CONFIGURATION:
+
+If this configuration option is undefined, then the described feature is not
+enabled.
-OPTION TYPE:
- This configuration option is a boolean feature define.
+.. rubric:: DESCRIPTION:
-DEFAULT CONFIGURATION:
- If this configuration option is undefined, then the described feature is not
- enabled.
+In case this configuration option is defined, then exactly one POSIX
+initialization thread is configured.
-DESCRIPTION:
- In case this configuration option is defined, then exactly one POSIX
- initialization thread is configured.
+.. rubric:: NOTES:
-NOTES:
- The application shall define exactly one of the following configuration
- options
+The application shall define exactly one of the following configuration
+options
- * :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
+* :ref:`CONFIGURE_RTEMS_INIT_TASKS_TABLE`,
- * ``CONFIGURE_POSIX_INIT_THREAD_TABLE``, or
+* ``CONFIGURE_POSIX_INIT_THREAD_TABLE``, or
- * :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
+* :ref:`CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION`
- otherwise a compile time error in the configuration file will occur.
+otherwise a compile time error in the configuration file will occur.