dmbcs/guile
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

a number of doc fixes

Browse source 
* 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".
This commit is contained in:
Andy Wingo 2010-08-12 13:04:08 +02:00
commit 7545ddd42a
9 changed files with 29 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/ref/api-deprecated.texi
View file

@ -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.