diff options
| author | Gedare Bloom <gedare@rtems.org> | 2015-03-06 12:41:49 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2015-03-10 12:53:07 -0400 |
| commit | 3ac681191ec76f7c0a876f2f2cc33adad9a99cc0 (patch) | |
| tree | 82b28c195eef15fdbb9f6e0459d53260597e42d2 /doc/user/task.t | |
| parent | cpukit/libcrypt/misc.c: Reverse order of statements in ifdef (diff) | |
| download | rtems-3ac681191ec76f7c0a876f2f2cc33adad9a99cc0.tar.bz2 | |
cpukit: deprecate notepads
Deprecate Classic API Notepads. Mark task_set/get_note() with
the deprecated attribute, and also mark the notepads field.
Replace disable with enable option for notepads in confdefs.h,
and make notepads disabled by default. The previous option
CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS is now unused and
will emit a compile-time warning. A new option
CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS is available to turn
on notepads, but it also will emit a compile-time warning
to indicate that notepads are deprecated.
Closes #2265
Diffstat (limited to 'doc/user/task.t')
| -rw-r--r-- | doc/user/task.t | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/user/task.t b/doc/user/task.t index cf7a514b1a..5aec9b19cc 100644 --- a/doc/user/task.t +++ b/doc/user/task.t @@ -645,6 +645,7 @@ to set a task's notepad entry to a specified note. The @code{@value{DIRPREFIX}task_get_note} directive allows the user to obtain the note contained in any one of the sixteen notepads of a specified task. +Notepads are deprecated and will be removed. @subsection Task Deletion @@ -1515,6 +1516,8 @@ This directive returns the note contained in the notepad location of the task specified by id. @subheading NOTES: +This directive is deprecated and will be removed. + This directive will not cause the running task to be preempted. If id is set to @code{@value{RPREFIX}SELF}, @@ -1567,6 +1570,8 @@ procedure Task_Set_Note ( @code{@value{RPREFIX}INVALID_NUMBER} - invalid notepad location @subheading DESCRIPTION: +This directive is deprecated and will be removed. + This directive sets the notepad entry for the task specified by id to the value note. |