doc/obsolete.texi

   1 @node Obsolete modules
   2 @section Obsolete modules
   3
   4 @cindex Obsolete modules
   5 Modules can be marked obsolete.  This means that the problems they fix
   6 don't occur any more on the platforms that are reasonable porting targets
   7 now.  @code{gnulib-tool} warns when obsolete modules are mentioned on the
   8 command line, and by default ignores dependencies from modules to obsolete
   9 modules.  When you pass the option @code{--with-obsolete} to
  10 @code{gnulib-tool}, dependencies to obsolete modules will be included,
  11 however, unless blocked through an @code{--avoid} option.  This option
  12 is useful if your package should be portable even to very old platforms.
  13
  14 In order to mark a module obsolete, you need to add this to the module
  15 description:
  16
  17 @example
  18 Status:
  19 obsolete
  20
  21 Notice:
  22 This module is obsolete.
  23 @end example