summaryrefslogtreecommitdiffstats
path: root/c_user/configuring_a_system.rst
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2016-11-01 16:05:08 -0500
committerJoel Sherrill <joel@rtems.org>2016-11-01 16:05:54 -0500
commitc29f5bcbcfa9ddec26af60a8d1b65af3076d9366 (patch)
treea200597ae23054ba61182823b53b9ea789cbefdf /c_user/configuring_a_system.rst
parentAdd some notes on writing documentation. (diff)
downloadrtems-docs-c29f5bcbcfa9ddec26af60a8d1b65af3076d9366.tar.bz2
c_user: Re-add task notepads for 4.11. Remove this patch after branching.
Diffstat (limited to 'c_user/configuring_a_system.rst')
-rw-r--r--c_user/configuring_a_system.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/c_user/configuring_a_system.rst b/c_user/configuring_a_system.rst
index 9c36b2d..e993877 100644
--- a/c_user/configuring_a_system.rst
+++ b/c_user/configuring_a_system.rst
@@ -565,6 +565,38 @@ assumption that all tasks have floating point enabled. This would require the
addition of a new configuration parameter to specify the number of tasks which
enable floating point support.
+.. COMMENT: === CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS ===
+
+.. _Specify Maximum Classic API Timers:
+
+Specify Maximum Classic API Timers
+----------------------------------
+.. index:: CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
+
+*CONSTANT:*
+ ``CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS``
+
+*DATA TYPE:*
+ Boolean feature macro.
+
+*RANGE:*
+ Defined or undefined.
+
+*DEFAULT VALUE:*
+ This is not defined by default, and Classic API Notepads are not supported.
+
+**DESCRIPTION:**
+ ``CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS`` should be defined if the
+ user wants to have support for Classic API Notepads in their application.
+
+**NOTES:**
+ Disabling Classic API Notepads saves the allocation of sixteen (16)
+ thirty-two bit integers. This saves sixty-four bytes per task/thread
+ plus the allocation overhead. Notepads are rarely used in applications
+ and this can save significant memory in a low RAM system. Classic API
+ Notepads are deprecated, and this option has been removed from
+ post 4.11 versions of RTEMS.
+
.. COMMENT: === CONFIGURE_MAXIMUM_TIMERS ===
.. _Specify Maximum Classic API Timers: