mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-10 14:00:21 +02:00
Code Activity

* Various small doc fixes.

Browse source
This commit is contained in:
Neil Jerram 2001-11-13 00:29:59 +00:00
parent 32776e8d99
commit 64744a7ff8
6 changed files with 48 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

1
THANKS
View file

@ -44,6 +44,7 @@ For fixes or providing information which led to a fix:
Brad Knotwell
Bruce Korb
Matthias Köppe
Scott Lenser
Ralf Mattes
Shuji Narazaki
Han-Wen Nienhuys

5
doc/maint/ChangeLog
View file

@ -1,3 +1,8 @@
2001-11-12 Neil Jerram <neil@ossau.uklinux.net>
* docstring.el, README: Sync up with unstable version of these
files.
2001-04-03 Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
* guile.texi: Automated docstring merging.

17
doc/maint/README
View file

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

53
doc/maint/docstring.el
View file

@ -57,52 +57,27 @@
;;; Code:
(defvar docstring-manual-directory (expand-file-name "~/Guile/cvs/guile-core/doc")
(defvar guile-core-dir (or (getenv "GUILE_MAINTAINER_GUILE_CORE_DIR")
"~/Guile/cvs/guile-core"))
(defvar docstring-manual-directory (expand-file-name "doc/ref" guile-core-dir)
"*The directory containing the Texinfo source for the Guile reference manual.")
(defvar docstring-tracking-root (expand-file-name "~/Guile/cvs/guile-core/doc/maint")
(defvar docstring-tracking-root (expand-file-name "doc/maint" guile-core-dir)
"*Root directory for docstring tracking files. The tracking file
for module (a b c) is expected to be in the file
<docstring-tracking-root>/a/b/c.texi.")
(defvar docstring-snarfed-roots (list (expand-file-name "~/Guile/cvs/guile-core/libguile")
(expand-file-name "~/Guile/cvs/guile-core/ice-9")
(expand-file-name "~/Guile/cvs/guile-core/oop"))
(defvar docstring-snarfed-roots (mapcar
#'(lambda (frag)
(expand-file-name frag guile-core-dir))
'("libguile" "ice-9" "oop"))
"*List of possible root directories for snarfed docstring files.
For each entry in this list, the snarfed docstring file for module (a
b c) is looked for in the file <entry>/a/b/c.texi.")
(defvar docstring-manual-files '("appendices.texi"
"deprecated.texi"
"expect.texi"
"gh.texi"
"goops.texi"
"guile.texi"
"indices.texi"
"intro.texi"
"posix.texi"
"scheme-binding.texi"
"scheme-control.texi"
"scheme-data.texi"
"scheme-debug.texi"
"scheme-evaluation.texi"
"scheme-ideas.texi"
"scheme-indices.texi"
"scheme-intro.texi"
"scheme-io.texi"
"scheme-memory.texi"
"scheme-modules.texi"
"scheme-options.texi"
"scheme-procedures.texi"
"scheme-reading.texi"
"scheme-scheduling.texi"
"scheme-translation.texi"
"scheme-utility.texi"
"scm.texi"
"scripts.texi"
"scsh.texi"
"slib.texi"
"tcltk.texi")
(defvar docstring-manual-files
(directory-files docstring-manual-directory nil "\\.texi$" t)
"List of Texinfo source files that comprise the Guile reference manual.")
(defvar docstring-new-docstrings-file "new-docstrings.texi"
@ -284,7 +259,7 @@ to which new docstrings should be added.")
(setq action nil
issue (if manual-location
'consider-removal
nil)))
nil)))
((null manual-location)
(setq action 'add-to-manual issue nil))
@ -522,7 +497,7 @@ new snarfed docstring file.\n\n")
(docstring-narrow-to-location manual-location)
(add-hook 'ediff-quit-hook 'docstring-widen-ediff-buffers)
(ediff-buffers3 (nth 0 docstring-ediff-buffers)
(nth 1 docstring-ediff-buffers)
(nth 2 docstring-ediff-buffers)))))
@ -561,3 +536,5 @@ new snarfed docstring file.\n\n")
;(find-snarfed-docstring '(guile) "primitive sloppy-assq")
(provide 'docstring)
;;; docstring.el ends here

10
doc/ref/ChangeLog
View file

@ -1,3 +1,13 @@
2001-11-13 Neil Jerram <neil@ossau.uklinux.net>
* scheme-data.texi (String Predicates): Correct doc for
string-null?. Thanks to Scott Lenser!
2001-11-12 Neil Jerram <neil@ossau.uklinux.net>
* scheme-data.texi (String Searching): Add missing "for". Thanks
to Scott Lenser.
2001-11-06 Thien-Thi Nguyen <ttn@glug.org>
* srfi-modules.texi (SRFI-19, SRFI-19 Constants, SRFI-19 Current

6
doc/ref/scheme-data.texi
View file

@ -1414,7 +1414,7 @@ Return @code{#t} iff @var{obj} is a string, else @code{#f}.
@end deffn
@deffn primitive string-null? str
Return @code{#t} if @var{str}'s length is nonzero, and
Return @code{#t} if @var{str}'s length is zero, and
@code{#f} otherwise.
@lisp
(string-null? "") @result{} #t
@ -1689,8 +1689,8 @@ equal to @var{s2} regardless of case.
@node String Searching
@subsection String Searching
When searching the index of a character in a string, these procedures
can be used.
When searching for the index of a character in a string, these
procedures can be used.
@deffn primitive string-index str chr [frm [to]]
Return the index of the first occurrence of @var{chr} in