Point to source for docstring.el customization.
Add "For Example" section.
This commit is contained in:
parent
697440cbc0
commit
de852d1474
1 changed files with 14 additions and 3 deletions
|
|
@ -8,10 +8,21 @@ in the libguile C source change.
|
|||
|
||||
- README is this file.
|
||||
|
||||
- docstring.el is a helpful Emacs Lisp library. The two key entry
|
||||
points are `docstring-process-module' and
|
||||
`docstring-ediff-this-line'.
|
||||
- docstring.el is a helpful Emacs Lisp library (see source for
|
||||
customziation). 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'.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue