mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 11:50:28 +02:00
Code Activity
guile/doc/maint
History
Neil Jerram 3323ec063c Automatic manual updates following libguile docstring changes 
Affecting the following procedures:

* doc/ref/api-compound.texi (Uniform Numeric Vectors):
  uniform-array-read!

* doc/ref/api-data.texi (Complex): make-rectangular, string=?,
  string<?, string<=?, string>?, string>=?, string-ci=?, string-ci<?,
  string-ci<=?, string-ci>?, string-ci>=?, string-append/shared

* doc/ref/api-evaluation.texi (Reader Extensions): read-hash-extend

* doc/ref/api-procedures.texi (Procedures with Setters): procedure,
  macro?, macro-type

* doc/ref/api-undocumented.texi: module-import-interface,
  %method-more-specific?

* doc/ref/new-docstrings.texi: uniform-array->bytevector,
  %start-stack, guardian-destroyed?, guardian-greedy?,
  destroy-guardian!, gc-dump, gc-disable, gc-enable,
  make-generalized-vector, set-primitive-generic!, nl-langinfo,
  %warn-autocompilation-enabled, make-syncase-macro,
  make-extended-syncase-macro, syncase-macro-type,
  syncase-macro-binding, memoize-expression, unmemoize-expression,
  memoized-expression-typecode, memoized-expression-data,
  memoized-typecode, memoize-variable-access!, module-local-variable,
  module-variable, eval-closure-module, module-transformer,
  module-public-interface, define!, module-reverse-lookup, cddr,
  make-promise, %get-stack-size, %string-dump, %symbol-dump,
  string-bytes-per-char, uniform-vector-element-type,
  uniform-vector-element-size, canonicalize-path, getrlimit, setrlimit

* doc/maint/guile.texi: Corresponding tracking updates.
2009-12-27 23:24:09 +00: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 Automatic manual updates following libguile docstring changes 2009-12-27 23:24:09 +00:00
README * docstring.el: optional 2nd environment variable to locate 2002-07-10 17:18:41 +00:00

README 

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