[rtems-docs commit] c-user: Canonicalize configuration option groups
Sebastian Huber
sebh at rtems.org
Wed Mar 18 06:32:44 UTC 2020
Module: rtems-docs
Branch: master
Commit: 79fb6fddf831586231b0b101790b59f11e708bb5
Changeset: http://git.rtems.org/rtems-docs/commit/?id=79fb6fddf831586231b0b101790b59f11e708bb5
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Mar 17 09:10:15 2020 +0100
c-user: Canonicalize configuration option groups
Update #3836.
---
c-user/config/bdbuf.rst | 4 ++--
c-user/config/classic-api.rst | 3 +--
c-user/config/classic-init-task.rst | 5 ++---
c-user/config/device-driver.rst | 8 ++------
c-user/config/event-record.rst | 2 ++
c-user/config/filesystem.rst | 1 +
c-user/config/general.rst | 3 +--
c-user/config/idle-task.rst | 3 +--
c-user/config/mpci.rst | 13 ++++++-------
c-user/config/posix-api.rst | 8 ++++----
c-user/config/posix-init-thread.rst | 5 ++---
c-user/config/scheduler-clustered.rst | 1 +
c-user/config/scheduler-general.rst | 14 ++++++++------
c-user/config/task-stack-alloc.rst | 7 ++++---
14 files changed, 37 insertions(+), 40 deletions(-)
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 7c3114c..2aaa310 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -5,8 +5,8 @@
Block Device Cache Configuration
================================
-This section defines Block Device Cache (bdbuf) related configuration
-parameters.
+This section describes configuration options related to the Block Device Cache
+(bdbuf).
.. index:: CONFIGURE_APPLICATION_NEEDS_LIBBLOCK
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
index 6c8f6ca..3647d05 100644
--- a/c-user/config/classic-api.rst
+++ b/c-user/config/classic-api.rst
@@ -5,8 +5,7 @@
Classic API Configuration
=========================
-This section defines the Classic API related system configuration parameters
-supported by ``<rtems/confdefs.h>``.
+This section describes configuration options related to the Classic API.
.. index:: CONFIGURE_MAXIMUM_BARRIERS
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
index cbbec9a..8eaafca 100644
--- a/c-user/config/classic-init-task.rst
+++ b/c-user/config/classic-init-task.rst
@@ -5,9 +5,8 @@
Classic API Initialization Task Configuration
=============================================
-The ``<rtems/confdefs.h>`` configuration system can automatically generate an
-Initialization Tasks Table named ``Initialization_tasks`` with a single entry.
-The following parameters control the generation of that table.
+This section describes configuration options related to the Classic API
+initialization task.
.. index:: CONFIGURE_INIT_TASK_ARGUMENTS
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index 38638ce..7a1196d 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -5,12 +5,8 @@
Device Driver Configuration
===========================
-This section defines the configuration parameters related to the automatic
-generation of a Device Driver Table. As ``<rtems/confdefs.h>`` only is aware
-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.
+This section describes configuration options related to the device drivers.
+Note that network device drivers are not covered by the following options.
.. index:: CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index 6ac0db0..01e9af2 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -5,6 +5,8 @@
Event Recording Configuration
=============================
+This section describes configuration options related to the event recording.
+
.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 8ed297e..dee1bd3 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -5,6 +5,7 @@
Filesystem Configuration
========================
+This section describes configuration options related to filesytems.
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,
you can disable the filesystem support with the
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index 2170428..1ef1fe9 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -5,8 +5,7 @@
General System Configuration
============================
-This section defines the general system configuration options supported by
-``<rtems/confdefs.h>``.
+This section describes general system configuration options.
.. index:: CONFIGURE_DIRTY_MEMORY
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst
index ef8b192..a39aaa1 100644
--- a/c-user/config/idle-task.rst
+++ b/c-user/config/idle-task.rst
@@ -5,8 +5,7 @@
Idle Task Configuration
=======================
-This section defines the IDLE task related configuration parameters supported
-by ``<rtems/confdefs.h>``.
+This section describes configuration options related to the idle tasks.
.. index:: CONFIGURE_IDLE_TASK_BODY
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index 46b69b7..a3d0620 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -5,13 +5,12 @@
Multiprocessing Configuration
=============================
-This section defines the multiprocessing related system configuration
-parameters supported by ``<rtems/confdefs.h>``. They are only used if RTEMS
-was built with the ``--enable-multiprocessing`` build configuration option.
-The multiprocessing (MPCI) support must not be confused with the SMP support.
-
-Additionally, this class of Configuration Constants are only applicable if
-``CONFIGURE_MP_APPLICATION`` is defined.
+This section describes multiprocessing related configuration options. The
+options are only used if RTEMS was built with the ``--enable-multiprocessing``
+build configuration option. Additionally, this class of configuration options
+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
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index 7901fc7..13ac18d 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -5,10 +5,10 @@
POSIX API Configuration
=======================
-The parameters in this section are used to configure resources for the POSIX
-API supported by RTEMS. Most POSIX API objects are available by default since
-RTEMS 5.1. The queued signals and timers are only available if RTEMS was built
-with the ``--enable-posix`` build configuration option.
+This section describes configuration options related to the POSIX API. Most
+POSIX API objects are available by default since RTEMS 5.1. The queued signals
+and timers are only available if RTEMS was built with the ``--enable-posix``
+build configuration option.
.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS
diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst
index 04027fa..50c86ee 100644
--- a/c-user/config/posix-init-thread.rst
+++ b/c-user/config/posix-init-thread.rst
@@ -5,9 +5,8 @@
POSIX Initialization Thread Configuration
=========================================
-The ``<rtems/confdefs.h>`` configuration system can automatically generate a
-POSIX Initialization Threads Table named ``POSIX_Initialization_threads`` with
-a single entry. The following parameters control the generation of that table.
+This section describes configuration options related to the POSIX
+initialization thread.
.. index:: CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT
diff --git a/c-user/config/scheduler-clustered.rst b/c-user/config/scheduler-clustered.rst
index 0ea2f67..535829f 100644
--- a/c-user/config/scheduler-clustered.rst
+++ b/c-user/config/scheduler-clustered.rst
@@ -7,6 +7,7 @@
Clustered Scheduler Configuration
=================================
+This section describes configuration options related to clustered scheduling.
A clustered scheduler configuration is optional. It is an advanced
configuration area and only necessary in specific circumstances.
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 05fce6e..ac0b713 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -6,25 +6,27 @@
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
and only necessary in very specific circumstances. A normal application
configuration does not need any of the configuration options described in this
-section. By default, the :ref:`Deterministic Priority Scheduler
-<SchedulerPriority>` algorithm is used in uniprocessor configurations. In case
-SMP is enabled and the configured maximum processors
+section.
+
+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
than one, then the :ref:`Earliest Deadline First (EDF) SMP Scheduler
<SchedulerSMPEDF>` is selected as the default scheduler algorithm.
For the :ref:`schedulers built into
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.
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 macros.
+configuration option.
.. index:: CONFIGURE_SCHEDULER_CBS
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 8771ab7..e031595 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -5,9 +5,10 @@
Task Stack Allocator Configuration
==================================
-RTEMS allows the application or BSP to define its own allocation 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
+This section describes configuration options related to the task stack
+allocator. RTEMS allows the application or BSP to define its own allocation
+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.
.. index:: CONFIGURE_TASK_STACK_ALLOCATOR
More information about the vc
mailing list