From d5154d0f6a04f3b7ed59d9a09038576fe2640756 Mon Sep 17 00:00:00 2001
From: Aun-Ali Zaidi <admin@kodeit.net>
Date: Wed, 23 Dec 2015 14:44:02 -0600
Subject: api: Remove deprecated Notepads

Notepads where a feature of RTEMS' tasks that simply functioned in
the same way as POSIX keys or threaded local storage (TLS). They were
introduced well before per task variables, which are also deprecated,
and were barely used in favor of their POSIX alternatives.

In addition to their scarce usage, Notepads took up unnecessary memory.
For each task:

 - 16 32-bit integers were allocated.
 - A total of 64 bytes per task per thread.

This is especially critical in low memory and safety-critical applications.

They are also defined as uint32_t, and therefore are not guaranteed to
hold a pointer.

Lastly, they are not portable solutions for SMP and uniprocessor systems,
like POSIX keys and TLS.

updates #2493.
---
 doc/user/conf.t | 69 ---------------------------------------------------------
 1 file changed, 69 deletions(-)

(limited to 'doc/user/conf.t')

diff --git a/doc/user/conf.t b/doc/user/conf.t
index 0dd0a50924..560b221464 100644
--- a/doc/user/conf.t
+++ b/doc/user/conf.t
@@ -594,75 +594,6 @@ the 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.
 
-@c
-@c === CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS ===
-@c
-@subsection Enable Classic API Notepads
-
-@findex CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
-
-@table @b
-@item CONSTANT:
-@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}
-
-@item DATA TYPE:
-Boolean feature macro.
-
-@item RANGE:
-Defined or undefined.
-
-@item DEFAULT VALUE:
-This is not defined by default, and Classic API Notepads are not supported.
-
-@end table
-
-@subheading DESCRIPTION:
-@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS} should be defined if the
-user wants to have support for Classic API Notepads in their application.
-
-@subheading 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 is expected to be obsolete in
-the near future.
-
-@c
-@c === CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS ===
-@c
-@subsection Disable Classic API Notepads
-
-@findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
-
-@table @b
-@item CONSTANT:
-@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS}
-
-@item DATA TYPE:
-Boolean feature macro.
-
-@item RANGE:
-Defined or undefined.
-
-@item DEFAULT VALUE:
-This is not defined by default, and Classic API Notepads are not supported.
-
-@end table
-
-@subheading DESCRIPTION:
-@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} is deprecated. If users
-want to have support for Classic API Notepads, they should use
-@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}.
-
-@subheading 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 is expected to be obsolete in
-the near future.
-
 @c
 @c === CONFIGURE_MAXIMUM_TIMERS ===
 @c
-- 
cgit v1.2.3