[rtems-docs commit] c-user: Sort configuration options alphabetically

Sebastian Huber sebh at rtems.org
Tue Mar 17 13:13:45 UTC 2020 

Module:    rtems-docs
Branch:    master
Commit:    f3076bcd52ad1acf4ed5a0147a4ade659c6f8716
Changeset: http://git.rtems.org/rtems-docs/commit/?id=f3076bcd52ad1acf4ed5a0147a4ade659c6f8716

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Mar 17 14:10:58 2020 +0100

c-user: Sort configuration options alphabetically

Update #3836.

---

 c-user/config/bdbuf.rst      | 48 ++++++++++++++++++-------------------
 c-user/config/filesystem.rst | 50 +++++++++++++++++++--------------------
 c-user/config/posix-api.rst  | 56 ++++++++++++++++++++++----------------------
 3 files changed, 77 insertions(+), 77 deletions(-)

diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 011d4ee..7c3114c 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -35,77 +35,77 @@ NOTES:
     by the user with the configuration options below.  The Block Device Cache
     is used for example by the RFS and DOSFS file systems.
 
-.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
+.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
 
-.. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
+.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
 
-CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
----------------------------------
+CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+-------------------------------
 
 CONSTANT:
-    ``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
+    ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
 
 DATA TYPE:
-    Unsigned integer (``size_t``).
+    Unsigned integer (``uint32_t``).
 
 RANGE:
-    Positive.
+    It must be positive and an integral multiple of the buffer minimum size.
 
 DEFAULT VALUE:
-    The default value is 32768 bytes.
+    The default value is 4096 bytes.
 
 DESCRIPTION:
-    Size of the cache memory in bytes.
+    Defines the maximum size of a buffer in bytes.
 
 NOTES:
     None.
 
-.. index:: CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
 
-.. _CONFIGURE_BDBUF_BUFFER_MAX_SIZE:
+.. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
 
-CONFIGURE_BDBUF_BUFFER_MAX_SIZE
+CONFIGURE_BDBUF_BUFFER_MIN_SIZE
 -------------------------------
 
 CONSTANT:
-    ``CONFIGURE_BDBUF_BUFFER_MAX_SIZE``
+    ``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
 
 DATA TYPE:
     Unsigned integer (``uint32_t``).
 
 RANGE:
-    It must be positive and an integral multiple of the buffer minimum size.
+    Positive.
 
 DEFAULT VALUE:
-    The default value is 4096 bytes.
+    The default value is 512 bytes.
 
 DESCRIPTION:
-    Defines the maximum size of a buffer in bytes.
+    Defines the minimum size of a buffer in bytes.
 
 NOTES:
     None.
 
-.. index:: CONFIGURE_BDBUF_BUFFER_MIN_SIZE
+.. index:: CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
 
-.. _CONFIGURE_BDBUF_BUFFER_MIN_SIZE:
+.. _CONFIGURE_BDBUF_CACHE_MEMORY_SIZE:
 
-CONFIGURE_BDBUF_BUFFER_MIN_SIZE
--------------------------------
+CONFIGURE_BDBUF_CACHE_MEMORY_SIZE
+---------------------------------
 
 CONSTANT:
-    ``CONFIGURE_BDBUF_BUFFER_MIN_SIZE``
+    ``CONFIGURE_BDBUF_CACHE_MEMORY_SIZE``
 
 DATA TYPE:
-    Unsigned integer (``uint32_t``).
+    Unsigned integer (``size_t``).
 
 RANGE:
     Positive.
 
 DEFAULT VALUE:
-    The default value is 512 bytes.
+    The default value is 32768 bytes.
 
 DESCRIPTION:
-    Defines the minimum size of a buffer in bytes.
+    Size of the cache memory in bytes.
 
 NOTES:
     None.
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 43b0db0..687c0b9 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -18,6 +18,8 @@ advanced application configuration.
 Features of the IMFS can be disabled and enabled with the following
 configuration options:
 
+* :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO`
+
 * :ref:`CONFIGURE_IMFS_DISABLE_CHMOD`
 
 * :ref:`CONFIGURE_IMFS_DISABLE_CHOWN`
@@ -44,8 +46,6 @@ configuration options:
 
 * :ref:`CONFIGURE_IMFS_DISABLE_UTIME`
 
-* :ref:`CONFIGURE_IMFS_ENABLE_MKFIFO`
-
 .. index:: CONFIGURE_APPLICATION_DISABLE_FILESYSTEM
 
 .. _CONFIGURE_APPLICATION_DISABLE_FILESYSTEM:
@@ -74,29 +74,6 @@ DESCRIPTION:
 NOTES:
     None.
 
-.. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
-
-.. _CONFIGURE_IMFS_ENABLE_MKFIFO:
-
-CONFIGURE_IMFS_ENABLE_MKFIFO
-----------------------------
-
-CONSTANT:
-    ``CONFIGURE_IMFS_ENABLE_MKFIFO``
-
-DATA TYPE:
-    Boolean feature macro.
-
-RANGE:
-    Defined or undefined.
-
-DEFAULT VALUE:
-    This is not defined by default.
-
-DESCRIPTION:
-    In case this configuration option is defined, then the support to make FIFOs
-    is enabled in the root IMFS.
-
 .. index:: CONFIGURE_IMFS_DISABLE_CHMOD
 
 .. _CONFIGURE_IMFS_DISABLE_CHMOD:
@@ -397,6 +374,29 @@ DESCRIPTION:
     In case this configuration option is defined, then the support to change
     times is disabled in the root IMFS.
 
+.. index:: CONFIGURE_IMFS_ENABLE_MKFIFO
+
+.. _CONFIGURE_IMFS_ENABLE_MKFIFO:
+
+CONFIGURE_IMFS_ENABLE_MKFIFO
+----------------------------
+
+CONSTANT:
+    ``CONFIGURE_IMFS_ENABLE_MKFIFO``
+
+DATA TYPE:
+    Boolean feature macro.
+
+RANGE:
+    Defined or undefined.
+
+DEFAULT VALUE:
+    This is not defined by default.
+
+DESCRIPTION:
+    In case this configuration option is defined, then the support to make FIFOs
+    is enabled in the root IMFS.
+
 .. index:: CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK
 
 .. _CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK:
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index da5c0ba..7901fc7 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -155,15 +155,15 @@ NOTES:
     with ``sem_init()`` are not affected by this configuration option since the
     storage space for these semaphores is user-provided.
 
-.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
+.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
 
-.. _CONFIGURE_MAXIMUM_POSIX_TIMERS:
+.. _CONFIGURE_MAXIMUM_POSIX_THREADS:
 
-CONFIGURE_MAXIMUM_POSIX_TIMERS
-------------------------------
+CONFIGURE_MAXIMUM_POSIX_THREADS
+-------------------------------
 
 CONSTANT:
-    ``CONFIGURE_MAXIMUM_POSIX_TIMERS``
+    ``CONFIGURE_MAXIMUM_POSIX_THREADS``
 
 DATA TYPE:
     Unsigned integer (``uint32_t``).
@@ -175,24 +175,34 @@ DEFAULT VALUE:
     The default value is 0.
 
 DESCRIPTION:
-    ``CONFIGURE_MAXIMUM_POSIX_TIMERS`` is the maximum number of POSIX API
-    Timers that can be concurrently active.
+    ``CONFIGURE_MAXIMUM_POSIX_THREADS`` is the maximum number of POSIX API
+    Threads that can be concurrently active.
 
 NOTES:
     This object class can be configured in unlimited allocation mode.
 
-    Timers are only available if RTEMS was built with the
-    ``--enable-posix`` build configuration option.
+    This calculations for the required memory in the RTEMS Workspace for
+    threads assume that each thread has a minimum stack size and has floating
+    point support enabled.  The configuration parameter
+    ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify thread stack
+    requirements *ABOVE* the minimum size required.  See :ref:`Reserve
+    Task/Thread Stack Memory Above Minimum` for more information about
+    ``CONFIGURE_EXTRA_TASK_STACKS``.
 
-.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS
+    The maximum number of Classic API Tasks is specified by
+    :ref:`CONFIGURE_MAXIMUM_TASKS <CONFIGURE_MAXIMUM_TASKS>`.
 
-.. _CONFIGURE_MAXIMUM_POSIX_THREADS:
+    All POSIX threads have floating point enabled.
 
-CONFIGURE_MAXIMUM_POSIX_THREADS
--------------------------------
+.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS
+
+.. _CONFIGURE_MAXIMUM_POSIX_TIMERS:
+
+CONFIGURE_MAXIMUM_POSIX_TIMERS
+------------------------------
 
 CONSTANT:
-    ``CONFIGURE_MAXIMUM_POSIX_THREADS``
+    ``CONFIGURE_MAXIMUM_POSIX_TIMERS``
 
 DATA TYPE:
     Unsigned integer (``uint32_t``).
@@ -204,24 +214,14 @@ DEFAULT VALUE:
     The default value is 0.
 
 DESCRIPTION:
-    ``CONFIGURE_MAXIMUM_POSIX_THREADS`` is the maximum number of POSIX API
-    Threads that can be concurrently active.
+    ``CONFIGURE_MAXIMUM_POSIX_TIMERS`` is the maximum number of POSIX API
+    Timers that can be concurrently active.
 
 NOTES:
     This object class can be configured in unlimited allocation mode.
 
-    This calculations for the required memory in the RTEMS Workspace for
-    threads assume that each thread has a minimum stack size and has floating
-    point support enabled.  The configuration parameter
-    ``CONFIGURE_EXTRA_TASK_STACKS`` is used to specify thread stack
-    requirements *ABOVE* the minimum size required.  See :ref:`Reserve
-    Task/Thread Stack Memory Above Minimum` for more information about
-    ``CONFIGURE_EXTRA_TASK_STACKS``.
-
-    The maximum number of Classic API Tasks is specified by
-    :ref:`CONFIGURE_MAXIMUM_TASKS <CONFIGURE_MAXIMUM_TASKS>`.
-
-    All POSIX threads have floating point enabled.
+    Timers are only available if RTEMS was built with the
+    ``--enable-posix`` build configuration option.
 
 .. index:: CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE
 .. index:: minimum POSIX thread stack size

More information about the vc mailing list