document -q, repl options
[bpt/guile.git] / doc / ref / api-deprecated.texi
... / ...
CommitLineData
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
10From time to time functions and other features of Guile become obsolete.
11Guile's @dfn{deprecation} is a mechanism that can help you cope with
12this.
13
14When you use a feature that is deprecated, you will likely get a warning
15message at run-time. Also, if you have a new enough toolchain, using a
16deprecated function from @code{libguile} will cause a link-time warning.
17
18The primary source for information about just what interfaces are
19deprecated in a given release is the file @file{NEWS}. That file also
20documents what you should use instead of the obsoleted things.
21
22The file @file{README} contains instructions on how to control the
23inclusion or removal of the deprecated features from the public API of
24Guile, and how to control the deprecation warning messages.
25
26The idea behind this mechanism is that normally all deprecated
27interfaces are available, but you get feedback when compiling and
28running code that uses them, so that you can migrate to the newer APIs
29at your leisure.