HCoop / bpt / guile.git / blame
| Commit | Line | Data |
|---|---|---|
| 780ee65e NJ |
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 | ||
| de852d14 | 11 | - docstring.el is a helpful Emacs Lisp library (see source for |
| b56b5983 | 12 | customization). The two key entry points are: |
| de852d14 TTN |
13 | `docstring-process-module' and |
| 14 | `docstring-ediff-this-line'. | |
| 780ee65e NJ |
15 | |
| 16 | - guile.texi is a snapshot of the built file | |
| 17 | guile-core/libguile/guile.texi, copied last time the reference | |
| 18 | manual was determined to be in sync with the libguile source. | |
| de852d14 TTN |
19 | |
| 20 | For example: | |
| 21 | ||
| 22 | If you've just fixed a docstring in, say, ../libguile/strop.c, do in emacs: | |
| 23 | ||
| 24 | M-x load-file RET .../doc/maint/docstring.el RET | |
| 25 | M-x docstring-process-module RET (guile) RET | |
| 26 | ||
| 27 | Save all modified .texi files and copy the current ../libguile/guile.texi | |
| 28 | to ./guile.texi, then commit. See elisp var `docstring-snarfed-roots'. |