[rtems-docs commit] c-user: Move CONFIGURE_MEMORY_OVERHEAD

Sebastian Huber sebh at rtems.org
Wed Dec 11 08:07:29 UTC 2019


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

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Dec 10 13:58:57 2019 +0100

c-user: Move CONFIGURE_MEMORY_OVERHEAD

Move CONFIGURE_MEMORY_OVERHEAD to general system configuration.
Remove now empty "Seldom Used Configuration Parameters" section.

Update #3836.

---

 c-user/configuring_a_system.rst | 66 ++++++++++++++++++-----------------------
 1 file changed, 29 insertions(+), 37 deletions(-)

diff --git a/c-user/configuring_a_system.rst b/c-user/configuring_a_system.rst
index 8022f01..00973be 100644
--- a/c-user/configuring_a_system.rst
+++ b/c-user/configuring_a_system.rst
@@ -637,6 +637,35 @@ NOTE:
    The size of the thread control block is increased by the maximum thread name
    size.  This configuration option is available since RTEMS 5.1.
 
+.. index:: CONFIGURE_MEMORY_OVERHEAD
+
+.. _CONFIGURE_MEMORY_OVERHEAD:
+
+CONFIGURE_MEMORY_OVERHEAD
+-------------------------
+
+CONSTANT:
+    ``CONFIGURE_MEMORY_OVERHEAD``
+
+DATA TYPE:
+    Unsigned integer (``size_t``).
+
+RANGE:
+    Zero or positive.
+
+DEFAULT VALUE:
+    The default value is 0.
+
+DESCRIPTION:
+    This parameter is set to the number of kilobytes the application wishes to
+    add to the requirements calculated by ``<rtems/confdefs.h>``.
+
+NOTES:
+    This configuration parameter should only be used when it is suspected that
+    a bug in ``<rtems/confdefs.h>`` has resulted in an underestimation.
+    Typically the memory allocation will be too low when an application does
+    not account for all message queue buffers or task stacks.
+
 .. index:: CONFIGURE_MICROSECONDS_PER_TICK
 .. index:: tick quantum
 
@@ -2070,43 +2099,6 @@ NOTES:
                          500, sizeof(other_message_type) \
                      )
 
-Seldom Used Configuration Parameters
-====================================
-
-This section describes configuration parameters supported by
-``<rtems/confdefs.h>`` which are seldom used by applications. These parameters
-tend to be oriented to debugging system configurations and providing
-work-arounds when the memory estimated by ``<rtems/confdefs.h>`` is incorrect.
-
-.. index:: CONFIGURE_MEMORY_OVERHEAD
-
-.. _CONFIGURE_MEMORY_OVERHEAD:
-
-CONFIGURE_MEMORY_OVERHEAD
--------------------------
-
-CONSTANT:
-    ``CONFIGURE_MEMORY_OVERHEAD``
-
-DATA TYPE:
-    Unsigned integer (``size_t``).
-
-RANGE:
-    Zero or positive.
-
-DEFAULT VALUE:
-    The default value is 0.
-
-DESCRIPTION:
-    This parameter is set to the number of kilobytes the application wishes to
-    add to the requirements calculated by ``<rtems/confdefs.h>``.
-
-NOTES:
-    This configuration parameter should only be used when it is suspected that
-    a bug in ``<rtems/confdefs.h>`` has resulted in an underestimation.
-    Typically the memory allocation will be too low when an application does
-    not account for all message queue buffers or task stacks.
-
 C Library Support Configuration
 ===============================
 



More information about the vc mailing list