guile18/doc/maint/README

   1 README for guile-core/doc/maint                      -*- text -*-
   2
   3 The files in this directory are used by the maintainers to automate
   4 the process of updating the Guile reference manual when the docstrings
   5 in the libguile C source change.
   6
   7 - ChangeLog is the change log for files in this directory.
   8
   9 - README is this file.
  10
  11 - docstring.el is a helpful Emacs Lisp library (see source for
  12   customization).  The two key entry points are:
  13     `docstring-process-module' and
  14     `docstring-ediff-this-line'.
  15
  16 - guile.texi is a snapshot of the built file libguile/guile.texi,
  17   copied last time the reference manual was determined to be in sync
  18   with the libguile source.
  19
  20 docstring.el requires the setting of an environment variable, e.g.,
  21
  22 export GUILE_MAINTAINER_GUILE_CORE_DIR=$HOME/guile/guile-core
  23
  24 If the build directory differs from the source directory, an additional
  25 variable is required:
  26
  27 export GUILE_MAINTAINER_BUILD_CORE_DIR=$HOME/guile/guile-core-build
  28
  29 If you've just fixed a docstring in, say, ../libguile/strop.c, do in emacs:
  30
  31     M-x load-file RET .../doc/maint/docstring.el RET
  32     M-x docstring-process-module RET (guile) RET
  33
  34 Save all modified .texi files and copy the current ../libguile/guile.texi
  35 to ./guile.texi, then commit.  See elisp var `docstring-snarfed-roots'.