diff options
author | Andy Wingo <wingo@pobox.com> | 2010-08-12 13:04:08 +0200 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2010-08-16 21:36:14 -0700 |
commit | 7545ddd42a065da0d50b2d84e7889aeb5d71326b (patch) | |
tree | 61a0709f1389e41cce765f5f1ca9634ac9180cea /doc/ref/api-deprecated.texi | |
parent | 46088b26299cf427cd887c6289ea564ec33ecffb (diff) | |
download | guile-7545ddd42a065da0d50b2d84e7889aeb5d71326b.tar.gz |
a number of doc fixes
* doc/ref/api-control.texi (Handling Errors): Update docs for
display-error.
* libguile/backtrace.h (scm_i_display_error): Change prototype to
s/stack/frame/.
* libguile/throw.c (handler_message): Change invocation of
scm_i_display_error to pass a frame.
* doc/ref/api-deprecated.texi (Deprecation): Update wording.
* doc/ref/api-evaluation.texi (Local Evaluation): Remove section on
local-eval.
* doc/ref/api-macros.texi: Fix a couple typos.
* doc/ref/api-memory.texi (Objects): Remove terrible section.
* doc/ref/api-procedures.texi (Procedure Properties): Remove docs for
closure?.
(Compiled Procedures): Update wording.
* doc/ref/guile.texi (API Reference): Remove reference to "Objects".
Diffstat (limited to 'doc/ref/api-deprecated.texi')
-rw-r--r-- | doc/ref/api-deprecated.texi | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/ref/api-deprecated.texi b/doc/ref/api-deprecated.texi index ea18e4a6e..76f099727 100644 --- a/doc/ref/api-deprecated.texi +++ b/doc/ref/api-deprecated.texi @@ -11,21 +11,19 @@ From time to time functions and other features of Guile become obsolete. Guile's @dfn{deprecation} is a mechanism that can help you cope with this. -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 you use a feature that is deprecated, you will likely get a warning +message at run-time. Also, if you have a new enough toolchain, using a +deprecated function from @code{libguile} will cause a link-time warning. -Additionally, if you have a new enough toolchain, using a deprecated -function from @code{libguile} will cause a link-time warning. - -The primary source for information about just what things are deprecated -in a given release is the file @file{NEWS}. That file also documents -what you should use instead of the obsoleted things. +The primary source for information about just what interfaces are +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 features from the public API of Guile, and how to control the deprecation warning messages. -The idea behind those mechanisms is that normally all deprecated are -available, but you get feedback when compiling and running code that -uses them, so that you can migrate to the newer APIs at your leisure. +The idea behind this mechanism is that normally all deprecated +interfaces are available, but you get feedback when compiling and +running code that uses them, so that you can migrate to the newer APIs +at your leisure. |