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

Timestamp:

01/06/16 15:42:40 (8 years ago)

Author:

Ralph Holmes

Comment:

Fix link.

Developer/Coding/Deprecating

@@ -6 +6 @@
 
 == Use the deprecate attribute ==
-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,
+
+Add 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:
+
 {{{#!C
 /**
@@ -16 +18 @@
 
 == Add a warning for configured features in confdefs.h ==
-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
+
+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:
+
 {{{#!C
  #warning "CONFIGURE_FEATURE_XXX\n\t\t\t**** Deprecated and will be removed. ****"
-  }}}
+}}}
 
 == Update documentation ==
+
 Find 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.
 
 == Update support code using deprecated feature ==
+
 If 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.
 
@@ -56 +62 @@
 
 == Add a release note ==
+
 Add the feature to a list of deprecated interfaces in the release notes.