guile/guile-core/doc/maint README

[Thien-Thi Nguyen]

CVSROOT:        /cvs
Module name:    guile
Changes by:     Thien-Thi Nguyen <address@hidden>       01/11/12 03:37:03

Modified files:
        guile-core/doc/maint: README 

Log message:
        Point to source for docstring.el customization.
        Add "For Example" section.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/guile/guile-core/doc/maint/README.diff?cvsroot=OldCVS&tr1=1.2&tr2=1.3&r1=text&r2=text

Patches:
Index: guile/guile-core/doc/maint/README
diff -u guile/guile-core/doc/maint/README:1.2 
guile/guile-core/doc/maint/README:1.3
--- guile/guile-core/doc/maint/README:1.2       Fri Mar 23 12:24:27 2001
+++ guile/guile-core/doc/maint/README   Mon Nov 12 03:37:03 2001
@@ -8,10 +8,21 @@
 
 - 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'.