mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-22 04:30:19 +02:00
28 lines
1,020 B
Text
28 lines
1,020 B
Text
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
|
|
guile-core/libguile/guile.texi, copied last time the reference
|
|
manual was determined to be in sync with the libguile source.
|
|
|
|
For example:
|
|
|
|
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'.
|