Changes between Version 4 and Version 5 of Developer/Coding/Deprecating


Ignore:
Timestamp:
01/06/16 15:42:40 (7 years ago)
Author:
Ralph Holmes
Comment:

Fix link.

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Deprecating

    v4 v5  
    66
    77== Use the deprecate attribute ==
    8 Add the RTEMS_COMPILER_DEPRECATED_ATTRIBUTE, which for gcc wraps the [https://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html deprecated] attribute, to functions, structures, and global symbols exported by the deprecated interface. Update the doxygen for each of these with the @deprecated command, for example,
     8
     9Add the RTEMS_COMPILER_DEPRECATED_ATTRIBUTE, which for gcc wraps the [https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-g_t_0040code_007bdeprecated_007d-function-attribute-3175 deprecated attribute], to functions, structures, and global symbols exported by the deprecated interface. Update the doxygen for each of these with the @deprecated command, for example:
     10
    911{{{#!C
    1012/**
     
    1618
    1719== Add a warning for configured features in confdefs.h ==
    18 For features that are enabled or configured through confdefs.h, the feature should be disabled by default and a compile-time warning message should be printed, something along the lines of
     20
     21For features that are enabled or configured through confdefs.h, the feature should be disabled by default and a compile-time warning message should be printed, something along the lines of:
     22
    1923{{{#!C
    2024 #warning "CONFIGURE_FEATURE_XXX\n\t\t\t**** Deprecated and will be removed. ****"
    21   }}}
     25}}}
    2226
    2327== Update documentation ==
     28
    2429Find references to the deprecated feature in the user manuals (doc) and wiki, and make a note that the features are deprecated and may be removed.
    2530
    2631== Update support code using deprecated feature ==
     32
    2733If there is support code using the feature, you will need to modify that support code to not use that feature. If the code cannot be immediately modified, file a ticket on the issue and disable the deprecated warning. The code will need to be addressed before the feature can be removed.
    2834
     
    5662
    5763== Add a release note ==
     64
    5865Add the feature to a list of deprecated interfaces in the release notes.