From 64744a7ff8a8d3055a2e4cd2e8b52cee9c496553 Mon Sep 17 00:00:00 2001 From: Neil Jerram Date: Tue, 13 Nov 2001 00:29:59 +0000 Subject: [PATCH] * Various small doc fixes. --- THANKS | 1 + doc/maint/ChangeLog | 5 ++++ doc/maint/README | 17 ++++++++++--- doc/maint/docstring.el | 53 ++++++++++++---------------------------- doc/ref/ChangeLog | 10 ++++++++ doc/ref/scheme-data.texi | 6 ++--- 6 files changed, 48 insertions(+), 44 deletions(-) diff --git a/THANKS b/THANKS index 5ba44a125..cfecc204d 100644 --- a/THANKS +++ b/THANKS @@ -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 diff --git a/doc/maint/ChangeLog b/doc/maint/ChangeLog index 0572b38f3..f59acfafe 100644 --- a/doc/maint/ChangeLog +++ b/doc/maint/ChangeLog @@ -1,3 +1,8 @@ +2001-11-12 Neil Jerram + + * docstring.el, README: Sync up with unstable version of these + files. + 2001-04-03 Martin Grabmueller * guile.texi: Automated docstring merging. diff --git a/doc/maint/README b/doc/maint/README index d88589325..c06599127 100644 --- a/doc/maint/README +++ b/doc/maint/README @@ -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'. diff --git a/doc/maint/docstring.el b/doc/maint/docstring.el index b346b96bd..e0c05fa58 100644 --- a/doc/maint/docstring.el +++ b/doc/maint/docstring.el @@ -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 /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 /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 diff --git a/doc/ref/ChangeLog b/doc/ref/ChangeLog index b8b54fa6d..8b75f3583 100644 --- a/doc/ref/ChangeLog +++ b/doc/ref/ChangeLog @@ -1,3 +1,13 @@ +2001-11-13 Neil Jerram + + * scheme-data.texi (String Predicates): Correct doc for + string-null?. Thanks to Scott Lenser! + +2001-11-12 Neil Jerram + + * scheme-data.texi (String Searching): Add missing "for". Thanks + to Scott Lenser. + 2001-11-06 Thien-Thi Nguyen * srfi-modules.texi (SRFI-19, SRFI-19 Constants, SRFI-19 Current diff --git a/doc/ref/scheme-data.texi b/doc/ref/scheme-data.texi index 0dde98073..42e580c9e 100755 --- a/doc/ref/scheme-data.texi +++ b/doc/ref/scheme-data.texi @@ -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