Changeset 3ac68119 in rtems for doc/user/conf.t


Ignore:
Timestamp:
Mar 6, 2015, 5:41:49 PM (5 years ago)
Author:
Gedare Bloom <gedare@…>
Branches:
4.11, master
Children:
23e43f6
Parents:
b05549fc
git-author:
Gedare Bloom <gedare@…> (03/06/15 17:41:49)
git-committer:
Gedare Bloom <gedare@…> (03/10/15 16:53:07)
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/conf.t

    rb05549fc r3ac68119  
    596596
    597597@c
    598 @c === CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS ===
    599 @c
    600 @subsection Disable Classic API Notepads
    601 
    602 @findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    603 
    604 @table @b
    605 @item CONSTANT:
    606 @code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS}
    607 
    608 @item DATA TYPE:
    609 Boolean feature macro.
    610 
    611 @item RANGE:
    612 Defined or undefined.
    613 
    614 @item DEFAULT VALUE:
    615 This is not defined by default, and Classic API Notepads are supported.
    616 
    617 @end table
    618 
    619 @subheading DESCRIPTION:
    620 @code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} should be defined if the
    621 user does not want to have support for Classic API Notepads in their
    622 application.
     598@c === CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS ===
     599@c
     600@subsection Enable Classic API Notepads
     601
     602@findex CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     603
     604@table @b
     605@item CONSTANT:
     606@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}
     607
     608@item DATA TYPE:
     609Boolean feature macro.
     610
     611@item RANGE:
     612Defined or undefined.
     613
     614@item DEFAULT VALUE:
     615This is not defined by default, and Classic API Notepads are not supported.
     616
     617@end table
     618
     619@subheading DESCRIPTION:
     620@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS} should be defined if the
     621user wants to have support for Classic API Notepads in their application.
    623622
    624623@subheading NOTES:
     
    626625thirty-two bit integers. This saves sixty-four bytes per task/thread
    627626plus the allocation overhead. Notepads are rarely used in applications
    628 and this can save significant memory in a low RAM system.
     627and this can save significant memory in a low RAM system. Classic API
     628Notepads are deprecated, and this option is expected to be obsolete in
     629the near future.
     630
     631@c
     632@c === CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS ===
     633@c
     634@subsection Disable Classic API Notepads
     635
     636@findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
     637
     638@table @b
     639@item CONSTANT:
     640@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS}
     641
     642@item DATA TYPE:
     643Boolean feature macro.
     644
     645@item RANGE:
     646Defined or undefined.
     647
     648@item DEFAULT VALUE:
     649This is not defined by default, and Classic API Notepads are not supported.
     650
     651@end table
     652
     653@subheading DESCRIPTION:
     654@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} is deprecated. If users
     655want to have support for Classic API Notepads, they should use
     656@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}.
     657
     658@subheading NOTES:
     659Disabling Classic API Notepads saves the allocation of sixteen (16)
     660thirty-two bit integers. This saves sixty-four bytes per task/thread
     661plus the allocation overhead. Notepads are rarely used in applications
     662and this can save significant memory in a low RAM system. Classic API
     663Notepads are deprecated, and this option is expected to be obsolete in
     664the near future.
    629665
    630666@c
Note: See TracChangeset for help on using the changeset viewer.