doc/ref/api-deprecated.texi

   1 @c -*-texinfo-*-
   2 @c This is part of the GNU Guile Reference Manual.
   3 @c Copyright (C)  1996, 1997, 2000, 2001, 2002, 2003, 2004, 2010
   4 @c   Free Software Foundation, Inc.
   5 @c See the file guile.texi for copying conditions.
   6
   7 @node Deprecation
   8 @section Deprecation
   9
  10 From time to time functions and other features of Guile become obsolete.
  11 Guile's @dfn{deprecation} is a mechanism that can help you cope with
  12 this.
  13
  14 When you use a feature that is deprecated, you will likely get a warning
  15 message at run-time. Also, if you have a new enough toolchain, using a
  16 deprecated function from @code{libguile} will cause a link-time warning.
  17
  18 The primary source for information about just what interfaces are
  19 deprecated in a given release is the file @file{NEWS}.  That file also
  20 documents what you should use instead of the obsoleted things.
  21
  22 The file @file{README} contains instructions on how to control the
  23 inclusion or removal of the deprecated features from the public API of
  24 Guile, and how to control the deprecation warning messages.
  25
  26 The idea behind this mechanism is that normally all deprecated
  27 interfaces are available, but you get feedback when compiling and
  28 running code that uses them, so that you can migrate to the newer APIs
  29 at your leisure.