Changes between Version 1 and Version 2 of Developer/Coding/Deprecating


Ignore:
Timestamp:
Mar 10, 2015, 3:55:47 PM (4 years ago)
Author:
Gedare Bloom
Comment:

Write new advice for deprecating features.

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Deprecating

    v1 v2  
    55This page documents the procedures for deprecating a public-facing interface in RTEMS.
    66
    7 TODO
     7== Use the deprecate attribute ==
     8Add 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,
     9{{{#!C
     10/**
     11 * @brief RTEMS Feature
     12 *
     13 * @deprecated Feature is deprecated and will be removed.
     14 */
     15}}}
     16
     17== Add a warning for configured features in confdefs.h ==
     18For 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
     19{{{#!C
     20 #warning "CONFIGURE_FEATURE_XXX\n\t\t\t**** Deprecated and will be removed. ****"
     21  }}}
     22
     23== Update documentation ==
     24Find 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.
     25
     26== Add a release note ==
     27Add the feature to a list of deprecated interfaces in the release notes.
     28