mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-03 13:20:26 +02:00
029fa8965d
* doc/ref/intro.texi (Discouraged and Deprecated): Move from here... * doc/ref/api-discdepr.texi: ...to new file here. * doc/ref/guile.texi: Include api-discdepr.texi, and include `Discouraged and Deprecated' in API chapter menu. * doc/ref/Makefile.am (guile_TEXINFOS): Add api-discdepr.texi.
38 lines
1.6 KiB
Text
38 lines
1.6 KiB
Text
@c -*-texinfo-*-
|
|
@c This is part of the GNU Guile Reference Manual.
|
|
@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004
|
|
@c Free Software Foundation, Inc.
|
|
@c See the file guile.texi for copying conditions.
|
|
|
|
@node Discouraged and Deprecated
|
|
@section Discouraged and Deprecated
|
|
|
|
From time to time functions and other features of Guile become
|
|
obsolete. Guile has some mechanisms in place that can help you cope
|
|
with this.
|
|
|
|
Guile has two levels of obsoleteness: things can be @emph{deprecated},
|
|
meaning that their use is considered harmful and should be avoided,
|
|
even in old code; or they can be merely @emph{discouraged}, meaning
|
|
that they are fine in and of themselves, but that there are better
|
|
alternatives that should be used in new code.
|
|
|
|
When you use a feature that is deprecated, you will likely get a
|
|
warning message at run-time. Also, deprecated features are not ready
|
|
for production use: they might be very slow. When something is merely
|
|
discouraged, it performs normally and you wont get any messages at
|
|
run-time.
|
|
|
|
The primary source for information about just what things are
|
|
discouraged or deprecated in a given release is the file
|
|
@file{NEWS}. That file also documents what you should use instead
|
|
of the obsoleted things.
|
|
|
|
The file @file{README} contains instructions on how to control the
|
|
inclusion or removal of the deprecated and/or discouraged features
|
|
from the public API of Guile, and how to control the warning messages
|
|
for deprecated features.
|
|
|
|
The idea behind those mechanisms is that normally all deprecated and
|
|
discouraged features are available, but that you can omit them on
|
|
purpose to check whether your code still relies on them.
|