1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 03:40:34 +02:00
guile/doc/maint
Ken Raeburn 9515ef7237 Since support for "futures" in C has been completely disabled for some
time, and should be easily implementable in Scheme with the current
thread support, delete the C code.

* libguile/futures.c, libguile/futures.h: Delete.
* libguile/Makefile.am (libguile_la_SOURCES, DOT_X_FILES,
  DOT_DOC_FILES, modinclude_HEADERS): Delete references to futures.*
  files.

* libguile.h: Don't include futures.h.
* libguile/eval.c: Don't include futures.h.
  (isymnames): Delete "#@future" entry.
  (scm_m_future, s_future, scm_sym_future, unmemoize_future,
  unmemoize_builtin_macro): Delete disabled futures code.
* libguile/eval.i.c (CEVAL): Delete disabled futures code.
* libguile/init.c: Don't include futures.h.
  (scm_i_init_guile): Delete disabled futures initialization call.
* libguile/tags.h (SCM_IM_FUTURE): Delete.
  (SCM_IM_CALL_WITH_VALUES, SCM_IM_ELSE, SCM_IM_ARROW,
  SCM_IM_NIL_COND, SCM_IM_BIND): Renumber.

* doc/ref/api-scheduling.texi: Delete commented-out node on Futures.
* doc/maint/guile.texi: Delete make-future and future-ref mentions.
2009-10-30 18:40:41 -04:00
..
ChangeLog-2008 Rename ChangeLog' files to ChangeLog-2008'. 2008-09-12 21:49:58 +02:00
docstring.el Change Guile license to LGPLv3+ 2009-06-17 00:22:09 +01:00
guile.texi Since support for "futures" in C has been completely disabled for some 2009-10-30 18:40:41 -04:00
README * docstring.el: optional 2nd environment variable to locate 2002-07-10 17:18:41 +00:00

README for guile-core/doc/maint                      -*- text -*-

The files in this directory are used by the maintainers to automate
the process of updating the Guile reference manual when the docstrings
in the libguile C source change.

- ChangeLog is the change log for files in this directory.

- README is this file.

- docstring.el is a helpful Emacs Lisp library (see source for
  customization).  The two key entry points are:
    `docstring-process-module' and
    `docstring-ediff-this-line'.

- guile.texi is a snapshot of the built file libguile/guile.texi,
  copied last time the reference manual was determined to be in sync
  with the libguile source.

docstring.el requires the setting of an environment variable, e.g.,

export GUILE_MAINTAINER_GUILE_CORE_DIR=$HOME/guile/guile-core

If the build directory differs from the source directory, an additional
variable is required:

export GUILE_MAINTAINER_BUILD_CORE_DIR=$HOME/guile/guile-core-build

If you've just fixed a docstring in, say, ../libguile/strop.c, do in emacs:

    M-x load-file RET .../doc/maint/docstring.el RET
    M-x docstring-process-module RET (guile) RET

Save all modified .texi files and copy the current ../libguile/guile.texi
to ./guile.texi, then commit.  See elisp var `docstring-snarfed-roots'.