Mercurial > emacs
changeset 41218:ace002127a1c
(Fsnarf_documentation): Doc fix.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Sat, 17 Nov 2001 22:38:58 +0000 |
| parents | 096bd345e996 |
| children | 26455351ac47 |
| files | src/doc.c |
| diffstat | 1 files changed, 7 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/src/doc.c Sat Nov 17 22:37:39 2001 +0000 +++ b/src/doc.c Sat Nov 17 22:38:58 2001 +0000 @@ -462,12 +462,13 @@ 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; {