]> git.eshelyaron.com Git - emacs.git/commitdiff
(Fsnarf_documentation): Doc fix.
authorRichard M. Stallman <rms@gnu.org>
Sat, 17 Nov 2001 22:40:47 +0000 (22:40 +0000)
committerRichard M. Stallman <rms@gnu.org>
Sat, 17 Nov 2001 22:40:47 +0000 (22:40 +0000)
src/ChangeLog
src/doc.c

index f73c7ddcbc3712c694574e84af2bc4987cb7b841..e1021836d9c8cb9fd29f822ae9939d453d399c17 100644 (file)
@@ -1,3 +1,7 @@
+2001-11-17  Richard M. Stallman  <rms@gnu.org>
+
+       * doc.c (Fsnarf_documentation): Doc fix.
+
 2001-11-17  Andreas Schwab  <schwab@suse.de>
 
        * xterm.c (note_mouse_highlight): Fix type of variable `ignore'.
index c17386bc9799b50ce6a9acf3a6f94ec12d457126..be976909f61c67376e6ffb7c4fb71e98150c66dc 100644 (file)
--- a/src/doc.c
+++ b/src/doc.c
@@ -462,12 +462,13 @@ store_function_docstring (fun, offset)
 
 DEFUN ("Snarf-documentation", Fsnarf_documentation, Ssnarf_documentation,
        1, 1, 0,
-       doc: /* Used during Emacs initialization, before dumping runnable Emacs,
-to find pointers to doc strings stored in `etc/DOC...' and
-record them in function definitions.
-One arg, FILENAME, a string which does not include a directory.
-The file is found in `../etc' now; found in the `data-directory'
-when doc strings are referred to later in the dumped Emacs.  */)
+       doc: /* Used during Emacs initialization to scan the `etc/DOC...' file.
+This searches the `etc/DOC...' file for doc strings and
+records them in function and variable definitions.
+The function takes one argument, FILENAME, a string;
+it specifies the file name (without a directory) of the DOC file.
+That file is found in `../etc' now; later, when the dumped Emacs is run,
+the same file name is found in the `data-directory'.  */)
      (filename)
      Lisp_Object filename;
 {