c-user: Canonicalize configuration option groups

Update #3836.
This commit is contained in:
Sebastian Huber 2020-03-17 09:10:15 +01:00
parent 7a8d697d73
commit 79fb6fddf8
14 changed files with 37 additions and 40 deletions

View File

@ -5,8 +5,8 @@
Block Device Cache Configuration Block Device Cache Configuration
================================ ================================
This section defines Block Device Cache (bdbuf) related configuration This section describes configuration options related to the Block Device Cache
parameters. (bdbuf).
.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK .. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK

View File

@ -5,8 +5,7 @@
Classic API Configuration Classic API Configuration
========================= =========================
This section defines the Classic API related system configuration parameters This section describes configuration options related to the Classic API.
supported by ``<rtems/confdefs.h>``.
.. index:: CONFIGURE_MAXIMUM_BARRIERS .. index:: CONFIGURE_MAXIMUM_BARRIERS

View File

@ -5,9 +5,8 @@
Classic API Initialization Task Configuration Classic API Initialization Task Configuration
============================================= =============================================
The ``<rtems/confdefs.h>`` configuration system can automatically generate an This section describes configuration options related to the Classic API
Initialization Tasks Table named ``Initialization_tasks`` with a single entry. initialization task.
The following parameters control the generation of that table.
.. index:: CONFIGURE_INIT_TASK_ARGUMENTS .. index:: CONFIGURE_INIT_TASK_ARGUMENTS

View File

@ -5,12 +5,8 @@
Device Driver Configuration Device Driver Configuration
=========================== ===========================
This section defines the configuration parameters related to the automatic This section describes configuration options related to the device drivers.
generation of a Device Driver Table. As ``<rtems/confdefs.h>`` only is aware Note that network device drivers are not covered by the following options.
of a small set of standard device drivers, the generated Device Driver Table is
suitable for simple applications with no custom device drivers.
Note that network device drivers are not configured in the Device Driver Table.
.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER .. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER

View File

@ -5,6 +5,8 @@
Event Recording Configuration Event Recording Configuration
============================= =============================
This section describes configuration options related to the event recording.
.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED .. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED: .. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:

View File

@ -5,6 +5,7 @@
Filesystem Configuration Filesystem Configuration
======================== ========================
This section describes configuration options related to filesytems.
By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also By default, the In-Memory Filesystem (IMFS) is used as the base filesystem (also
known as root filesystem). In order to save some memory for your application, known as root filesystem). In order to save some memory for your application,
you can disable the filesystem support with the you can disable the filesystem support with the

View File

@ -5,8 +5,7 @@
General System Configuration General System Configuration
============================ ============================
This section defines the general system configuration options supported by This section describes general system configuration options.
``<rtems/confdefs.h>``.
.. index:: CONFIGURE_DIRTY_MEMORY .. index:: CONFIGURE_DIRTY_MEMORY

View File

@ -5,8 +5,7 @@
Idle Task Configuration Idle Task Configuration
======================= =======================
This section defines the IDLE task related configuration parameters supported This section describes configuration options related to the idle tasks.
by ``<rtems/confdefs.h>``.
.. index:: CONFIGURE_IDLE_TASK_BODY .. index:: CONFIGURE_IDLE_TASK_BODY

View File

@ -5,13 +5,12 @@
Multiprocessing Configuration Multiprocessing Configuration
============================= =============================
This section defines the multiprocessing related system configuration This section describes multiprocessing related configuration options. The
parameters supported by ``<rtems/confdefs.h>``. They are only used if RTEMS options are only used if RTEMS was built with the ``--enable-multiprocessing``
was built with the ``--enable-multiprocessing`` build configuration option. build configuration option. Additionally, this class of configuration options
The multiprocessing (MPCI) support must not be confused with the SMP support. are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
is defined. The multiprocessing (MPCI) support must not be confused with the
Additionally, this class of Configuration Constants are only applicable if SMP support.
``CONFIGURE_MP_APPLICATION`` is defined.
.. index:: CONFIGURE_MP_APPLICATION .. index:: CONFIGURE_MP_APPLICATION

View File

@ -5,10 +5,10 @@
POSIX API Configuration POSIX API Configuration
======================= =======================
The parameters in this section are used to configure resources for the POSIX This section describes configuration options related to the POSIX API. Most
API supported by RTEMS. Most POSIX API objects are available by default since POSIX API objects are available by default since RTEMS 5.1. The queued signals
RTEMS 5.1. The queued signals and timers are only available if RTEMS was built and timers are only available if RTEMS was built with the ``--enable-posix``
with the ``--enable-posix`` build configuration option. build configuration option.
.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS .. index:: CONFIGURE_MAXIMUM_POSIX_KEYS

View File

@ -5,9 +5,8 @@
POSIX Initialization Thread Configuration POSIX Initialization Thread Configuration
========================================= =========================================
The ``<rtems/confdefs.h>`` configuration system can automatically generate a This section describes configuration options related to the POSIX
POSIX Initialization Threads Table named ``POSIX_Initialization_threads`` with initialization thread.
a single entry. The following parameters control the generation of that table.
.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT .. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT

View File

@ -7,6 +7,7 @@
Clustered Scheduler Configuration Clustered Scheduler Configuration
================================= =================================
This section describes configuration options related to clustered scheduling.
A clustered scheduler configuration is optional. It is an advanced A clustered scheduler configuration is optional. It is an advanced
configuration area and only necessary in specific circumstances. configuration area and only necessary in specific circumstances.

View File

@ -6,25 +6,27 @@
General Scheduler Configuration General Scheduler Configuration
=============================== ===============================
This section defines the configuration parameters related to selecting a This section describes configuration options related to selecting a
scheduling algorithm for an application. A scheduler configuration is optional scheduling algorithm for an application. A scheduler configuration is optional
and only necessary in very specific circumstances. A normal application and only necessary in very specific circumstances. A normal application
configuration does not need any of the configuration options described in this configuration does not need any of the configuration options described in this
section. By default, the :ref:`Deterministic Priority Scheduler section.
<SchedulerPriority>` algorithm is used in uniprocessor configurations. In case
SMP is enabled and the configured maximum processors By default, the :ref:`Deterministic Priority Scheduler <SchedulerPriority>`
algorithm is used in uniprocessor configurations. In case SMP is enabled and
the configured maximum processors
(:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`) is greater (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`) is greater
than one, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler than one, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler
<SchedulerSMPEDF>` is selected as the default scheduler algorithm. <SchedulerSMPEDF>` is selected as the default scheduler algorithm.
For the :ref:`schedulers built into For the :ref:`schedulers built into
RTEMS <SchedulingConcepts>`, the configuration is straightforward. All that is RTEMS <SchedulingConcepts>`, the configuration is straightforward. All that is
required is to define the configuration macro which specifies which scheduler required is to define the configuration option which specifies which scheduler
you want for in your application. you want for in your application.
The pluggable scheduler interface also enables the user to provide their own The pluggable scheduler interface also enables the user to provide their own
scheduling algorithm. If you choose to do this, you must define multiple scheduling algorithm. If you choose to do this, you must define multiple
configuration macros. configuration option.
.. index:: CONFIGURE_SCHEDULER_CBS .. index:: CONFIGURE_SCHEDULER_CBS

View File

@ -5,9 +5,10 @@
Task Stack Allocator Configuration Task Stack Allocator Configuration
================================== ==================================
RTEMS allows the application or BSP to define its own allocation and This section describes configuration options related to the task stack
deallocation methods for task stacks. This can be used to place task stacks in allocator. RTEMS allows the application or BSP to define its own allocation
special areas of memory or to utilize a Memory Management Unit so that stack and deallocation methods for task stacks. This can be used to place task stacks
in special areas of memory or to utilize a Memory Management Unit so that stack
overflows are detected in hardware. overflows are detected in hardware.
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR .. index:: CONFIGURE_TASK_STACK_ALLOCATOR