1 /* Record indices of function doc strings stored in a file.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
25 #include <sys/file.h> /* Must be after sys/types.h for USG*/
44 #include "character.h"
48 Lisp_Object Vdoc_file_name
;
50 Lisp_Object Qfunction_documentation
;
52 /* A list of files used to build this Emacs binary. */
53 static Lisp_Object Vbuild_files
;
55 extern Lisp_Object Voverriding_local_map
, Qclosure
;
57 extern Lisp_Object Qremap
;
59 /* Buffer used for reading from documentation file. */
60 static char *get_doc_string_buffer
;
61 static int get_doc_string_buffer_size
;
63 static unsigned char *read_bytecode_pointer
;
64 Lisp_Object
Fsnarf_documentation (Lisp_Object
);
66 /* readchar in lread.c calls back here to fetch the next byte.
67 If UNREADFLAG is 1, we unread a byte. */
70 read_bytecode_char (int unreadflag
)
74 read_bytecode_pointer
--;
77 return *read_bytecode_pointer
++;
80 /* Extract a doc string from a file. FILEPOS says where to get it.
81 If it is an integer, use that position in the standard DOC-... file.
82 If it is (FILE . INTEGER), use FILE as the file name
83 and INTEGER as the position in that file.
84 But if INTEGER is negative, make it positive.
85 (A negative integer is used for user variables, so we can distinguish
86 them without actually fetching the doc string.)
88 If the location does not point to the beginning of a docstring
89 (e.g. because the file has been modified and the location is stale),
92 If UNIBYTE is nonzero, always make a unibyte string.
94 If DEFINITION is nonzero, assume this is for reading
95 a dynamic function definition; convert the bytestring
96 and the constants vector with appropriate byte handling,
97 and return a cons cell. */
100 get_doc_string (Lisp_Object filepos
, int unibyte
, int definition
)
105 register char *p
, *p1
;
107 int offset
, position
;
108 Lisp_Object file
, tem
;
110 if (INTEGERP (filepos
))
112 file
= Vdoc_file_name
;
113 position
= XINT (filepos
);
115 else if (CONSP (filepos
))
117 file
= XCAR (filepos
);
118 position
= XINT (XCDR (filepos
));
124 position
= - position
;
126 if (!STRINGP (Vdoc_directory
))
132 /* Put the file name in NAME as a C string.
133 If it is relative, combine it with Vdoc_directory. */
135 tem
= Ffile_name_absolute_p (file
);
138 minsize
= SCHARS (Vdoc_directory
);
139 /* sizeof ("../etc/") == 8 */
142 name
= (char *) alloca (minsize
+ SCHARS (file
) + 8);
143 strcpy (name
, SDATA (Vdoc_directory
));
144 strcat (name
, SDATA (file
));
148 name
= (char *) SDATA (file
);
151 fd
= emacs_open (name
, O_RDONLY
, 0);
155 if (!NILP (Vpurify_flag
))
157 /* Preparing to dump; DOC file is probably not installed.
158 So check in ../etc. */
159 strcpy (name
, "../etc/");
160 strcat (name
, SDATA (file
));
162 fd
= emacs_open (name
, O_RDONLY
, 0);
166 error ("Cannot open doc string file \"%s\"", name
);
169 /* Seek only to beginning of disk block. */
170 /* Make sure we read at least 1024 bytes before `position'
171 so we can check the leading text for consistency. */
172 offset
= min (position
, max (1024, position
% (8 * 1024)));
173 if (0 > lseek (fd
, position
- offset
, 0))
176 error ("Position %ld out of range in doc string file \"%s\"",
180 /* Read the doc string into get_doc_string_buffer.
181 P points beyond the data just read. */
183 p
= get_doc_string_buffer
;
186 int space_left
= (get_doc_string_buffer_size
187 - (p
- get_doc_string_buffer
));
190 /* Allocate or grow the buffer if we need to. */
193 int in_buffer
= p
- get_doc_string_buffer
;
194 get_doc_string_buffer_size
+= 16 * 1024;
195 get_doc_string_buffer
196 = (char *) xrealloc (get_doc_string_buffer
,
197 get_doc_string_buffer_size
+ 1);
198 p
= get_doc_string_buffer
+ in_buffer
;
199 space_left
= (get_doc_string_buffer_size
200 - (p
- get_doc_string_buffer
));
203 /* Read a disk block at a time.
204 If we read the same block last time, maybe skip this? */
205 if (space_left
> 1024 * 8)
206 space_left
= 1024 * 8;
207 nread
= emacs_read (fd
, p
, space_left
);
211 error ("Read error on documentation file");
216 if (p
== get_doc_string_buffer
)
217 p1
= strchr (p
+ offset
, '\037');
219 p1
= strchr (p
, '\037');
230 /* Sanity checking. */
234 if (get_doc_string_buffer
[offset
- test
++] != ' ')
236 while (get_doc_string_buffer
[offset
- test
] >= '0'
237 && get_doc_string_buffer
[offset
- test
] <= '9')
239 if (get_doc_string_buffer
[offset
- test
++] != '@'
240 || get_doc_string_buffer
[offset
- test
] != '#')
246 if (get_doc_string_buffer
[offset
- test
++] != '\n')
248 while (get_doc_string_buffer
[offset
- test
] > ' ')
250 if (get_doc_string_buffer
[offset
- test
] != '\037')
254 /* Scan the text and perform quoting with ^A (char code 1).
255 ^A^A becomes ^A, ^A0 becomes a null char, and ^A_ becomes a ^_. */
256 from
= get_doc_string_buffer
+ offset
;
257 to
= get_doc_string_buffer
+ offset
;
273 error ("Invalid data in documentation file -- ^A followed by code 0%o", c
);
279 /* If DEFINITION, read from this buffer
280 the same way we would read bytes from a file. */
283 read_bytecode_pointer
= get_doc_string_buffer
+ offset
;
284 return Fread (Qlambda
);
288 return make_unibyte_string (get_doc_string_buffer
+ offset
,
289 to
- (get_doc_string_buffer
+ offset
));
292 /* Let the data determine whether the string is multibyte,
293 even if Emacs is running in --unibyte mode. */
294 int nchars
= multibyte_chars_in_text (get_doc_string_buffer
+ offset
,
295 to
- (get_doc_string_buffer
+ offset
));
296 return make_string_from_bytes (get_doc_string_buffer
+ offset
,
298 to
- (get_doc_string_buffer
+ offset
));
302 /* Get a string from position FILEPOS and pass it through the Lisp reader.
303 We use this for fetching the bytecode string and constants vector
304 of a compiled function from the .elc file. */
307 read_doc_string (Lisp_Object filepos
)
309 return get_doc_string (filepos
, 0, 1);
313 reread_doc_file (Lisp_Object file
)
316 Lisp_Object reply
, prompt
[3];
319 prompt
[0] = build_string ("File ");
320 prompt
[1] = NILP (file
) ? Vdoc_file_name
: file
;
321 prompt
[2] = build_string (" is out of sync. Reload? ");
322 reply
= Fy_or_n_p (Fconcat (3, prompt
));
329 Fsnarf_documentation (Vdoc_file_name
);
331 Fload (file
, Qt
, Qt
, Qt
, Qnil
);
336 DEFUN ("documentation", Fdocumentation
, Sdocumentation
, 1, 2, 0,
337 doc
: /* Return the documentation string of FUNCTION.
338 Unless a non-nil second argument RAW is given, the
339 string is passed through `substitute-command-keys'. */)
340 (Lisp_Object function
, Lisp_Object raw
)
344 Lisp_Object tem
, doc
;
351 if (SYMBOLP (function
)
352 && (tem
= Fget (function
, Qfunction_documentation
),
354 return Fdocumentation_property (function
, Qfunction_documentation
, raw
);
356 fun
= Findirect_function (function
, Qnil
);
359 if (XSUBR (fun
)->doc
== 0)
361 else if ((EMACS_INT
) XSUBR (fun
)->doc
>= 0)
362 doc
= build_string (XSUBR (fun
)->doc
);
364 doc
= make_number ((EMACS_INT
) XSUBR (fun
)->doc
);
366 else if (COMPILEDP (fun
))
368 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) <= COMPILED_DOC_STRING
)
370 tem
= AREF (fun
, COMPILED_DOC_STRING
);
373 else if (NATNUMP (tem
) || CONSP (tem
))
378 else if (FUNVECP (fun
))
380 /* Unless otherwise handled, funvecs have no documentation. */
383 else if (STRINGP (fun
) || VECTORP (fun
))
385 return build_string ("Keyboard macro.");
387 else if (CONSP (fun
))
390 if (!SYMBOLP (funcar
))
391 xsignal1 (Qinvalid_function
, fun
);
392 else if (EQ (funcar
, Qkeymap
))
393 return build_string ("Prefix command (definition is a keymap associating keystrokes with commands).");
394 else if (EQ (funcar
, Qlambda
)
395 || EQ (funcar
, Qautoload
))
398 tem1
= Fcdr (Fcdr (fun
));
402 /* Handle a doc reference--but these never come last
403 in the function body, so reject them if they are last. */
404 else if ((NATNUMP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
405 && !NILP (XCDR (tem1
)))
410 else if (EQ (funcar
, Qclosure
))
411 return Fdocumentation (Fcdr (XCDR (fun
)), raw
);
412 else if (EQ (funcar
, Qmacro
))
413 return Fdocumentation (Fcdr (fun
), raw
);
420 xsignal1 (Qinvalid_function
, fun
);
423 /* Check for an advised function. Its doc string
424 has an `ad-advice-info' text property. */
427 Lisp_Object innerfunc
;
428 innerfunc
= Fget_text_property (make_number (0),
429 intern ("ad-advice-info"),
431 if (! NILP (innerfunc
))
432 doc
= call1 (intern ("ad-make-advised-docstring"), innerfunc
);
435 /* If DOC is 0, it's typically because of a dumped file missing
436 from the DOC file (bug in src/Makefile.in). */
437 if (EQ (doc
, make_number (0)))
439 if (INTEGERP (doc
) || CONSP (doc
))
442 tem
= get_doc_string (doc
, 0, 0);
443 if (NILP (tem
) && try_reload
)
445 /* The file is newer, we need to reset the pointers. */
446 struct gcpro gcpro1
, gcpro2
;
447 GCPRO2 (function
, raw
);
448 try_reload
= reread_doc_file (Fcar_safe (doc
));
461 doc
= Fsubstitute_command_keys (doc
);
465 DEFUN ("documentation-property", Fdocumentation_property
,
466 Sdocumentation_property
, 2, 3, 0,
467 doc
: /* Return the documentation string that is SYMBOL's PROP property.
468 Third argument RAW omitted or nil means pass the result through
469 `substitute-command-keys' if it is a string.
471 This differs from `get' in that it can refer to strings stored in the
472 `etc/DOC' file; and that it evaluates documentation properties that
474 (Lisp_Object symbol
, Lisp_Object prop
, Lisp_Object raw
)
479 documentation_property
:
481 tem
= Fget (symbol
, prop
);
482 if (EQ (tem
, make_number (0)))
484 if (INTEGERP (tem
) || (CONSP (tem
) && INTEGERP (XCDR (tem
))))
486 Lisp_Object doc
= tem
;
487 tem
= get_doc_string (tem
, 0, 0);
488 if (NILP (tem
) && try_reload
)
490 /* The file is newer, we need to reset the pointers. */
491 struct gcpro gcpro1
, gcpro2
, gcpro3
;
492 GCPRO3 (symbol
, prop
, raw
);
493 try_reload
= reread_doc_file (Fcar_safe (doc
));
498 goto documentation_property
;
502 else if (!STRINGP (tem
))
503 /* Feval protects its argument. */
506 if (NILP (raw
) && STRINGP (tem
))
507 tem
= Fsubstitute_command_keys (tem
);
511 /* Scanning the DOC files and placing docstring offsets into functions. */
514 store_function_docstring (Lisp_Object fun
, EMACS_INT offset
)
515 /* Use EMACS_INT because we get offset from pointer subtraction. */
517 fun
= indirect_function (fun
);
519 /* The type determines where the docstring is stored. */
521 /* Lisp_Subrs have a slot for it. */
523 XSUBR (fun
)->doc
= (char *) - offset
;
525 /* If it's a lisp form, stick it in the form. */
526 else if (CONSP (fun
))
531 if (EQ (tem
, Qlambda
) || EQ (tem
, Qautoload
))
533 tem
= Fcdr (Fcdr (fun
));
534 if (CONSP (tem
) && INTEGERP (XCAR (tem
)))
535 XSETCAR (tem
, make_number (offset
));
537 else if (EQ (tem
, Qmacro
))
538 store_function_docstring (XCDR (fun
), offset
);
539 else if (EQ (tem
, Qclosure
))
540 store_function_docstring (Fcdr (XCDR (fun
)), offset
);
543 /* Bytecode objects sometimes have slots for it. */
544 else if (COMPILEDP (fun
))
546 /* This bytecode object must have a slot for the
547 docstring, since we've found a docstring for it. */
548 if ((ASIZE (fun
) & PSEUDOVECTOR_SIZE_MASK
) > COMPILED_DOC_STRING
)
549 ASET (fun
, COMPILED_DOC_STRING
, make_number (offset
));
553 static const char buildobj
[] = BUILDOBJ
;
555 DEFUN ("Snarf-documentation", Fsnarf_documentation
, Ssnarf_documentation
,
557 doc
: /* Used during Emacs initialization to scan the `etc/DOC...' file.
558 This searches the `etc/DOC...' file for doc strings and
559 records them in function and variable definitions.
560 The function takes one argument, FILENAME, a string;
561 it specifies the file name (without a directory) of the DOC file.
562 That file is found in `../etc' now; later, when the dumped Emacs is run,
563 the same file name is found in the `doc-directory'. */)
564 (Lisp_Object filename
)
570 register char *p
, *end
;
575 CHECK_STRING (filename
);
579 (!NILP (Vpurify_flag
))
580 #else /* CANNOT_DUMP */
582 #endif /* CANNOT_DUMP */
584 name
= (char *) alloca (SCHARS (filename
) + 14);
585 strcpy (name
, "../etc/");
589 CHECK_STRING (Vdoc_directory
);
590 name
= (char *) alloca (SCHARS (filename
)
591 + SCHARS (Vdoc_directory
) + 1);
592 strcpy (name
, SDATA (Vdoc_directory
));
594 strcat (name
, SDATA (filename
)); /*** Add this line ***/
596 /* Vbuild_files is nil when temacs is run, and non-nil after that. */
597 if (NILP (Vbuild_files
))
599 const char *beg
, *end
;
601 for (beg
= buildobj
; *beg
; beg
= end
)
605 while (*beg
&& isspace (*beg
)) ++beg
;
607 for (end
= beg
; *end
&& ! isspace (*end
); ++end
)
608 if (*end
== '/') beg
= end
+1; /* skip directory part */
611 if (len
> 4 && end
[-4] == '.' && end
[-3] == 'o')
612 len
-= 2; /* Just take .o if it ends in .obj */
615 Vbuild_files
= Fcons (make_string (beg
, len
), Vbuild_files
);
617 Vbuild_files
= Fpurecopy (Vbuild_files
);
620 fd
= emacs_open (name
, O_RDONLY
, 0);
622 report_file_error ("Opening doc string file",
623 Fcons (build_string (name
), Qnil
));
624 Vdoc_file_name
= filename
;
630 filled
+= emacs_read (fd
, &buf
[filled
], sizeof buf
- 1 - filled
);
636 end
= buf
+ (filled
< 512 ? filled
: filled
- 128);
637 while (p
!= end
&& *p
!= '\037') p
++;
638 /* p points to ^_Ffunctionname\n or ^_Vvarname\n. */
641 end
= strchr (p
, '\n');
643 /* See if this is a file name, and if it is a file in build-files. */
644 if (p
[1] == 'S' && end
- p
> 4 && end
[-2] == '.'
645 && (end
[-1] == 'o' || end
[-1] == 'c'))
647 int len
= end
- p
- 2;
648 char *fromfile
= alloca (len
+ 1);
649 strncpy (fromfile
, &p
[2], len
);
651 if (fromfile
[len
-1] == 'c')
652 fromfile
[len
-1] = 'o';
654 skip_file
= NILP (Fmember (build_string (fromfile
),
658 sym
= oblookup (Vobarray
, p
+ 2,
659 multibyte_chars_in_text (p
+ 2, end
- p
- 2),
661 /* Check skip_file so that when a function is defined several
662 times in different files (typically, once in xterm, once in
663 w32term, ...), we only pay attention to the one that
665 if (! skip_file
&& SYMBOLP (sym
))
667 /* Attach a docstring to a variable? */
670 /* Install file-position as variable-documentation property
671 and make it negative for a user-variable
672 (doc starts with a `*'). */
673 Fput (sym
, Qvariable_documentation
,
674 make_number ((pos
+ end
+ 1 - buf
)
675 * (end
[1] == '*' ? -1 : 1)));
678 /* Attach a docstring to a function? */
679 else if (p
[1] == 'F')
680 store_function_docstring (sym
, pos
+ end
+ 1 - buf
);
682 else if (p
[1] == 'S')
683 ; /* Just a source file name boundary marker. Ignore it. */
686 error ("DOC file invalid at position %d", pos
);
691 memcpy (buf
, end
, filled
);
697 DEFUN ("substitute-command-keys", Fsubstitute_command_keys
,
698 Ssubstitute_command_keys
, 1, 1, 0,
699 doc
: /* Substitute key descriptions for command names in STRING.
700 Substrings of the form \\=\\[COMMAND] replaced by either: a keystroke
701 sequence that will invoke COMMAND, or "M-x COMMAND" if COMMAND is not
703 Substrings of the form \\=\\{MAPVAR} are replaced by summaries
704 \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
705 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
706 as the keymap for future \\=\\[COMMAND] substrings.
707 \\=\\= quotes the following character and is discarded;
708 thus, \\=\\=\\=\\= puts \\=\\= into the output, and \\=\\=\\=\\[ puts \\=\\[ into the output.
710 Returns original STRING if no substitutions were made. Otherwise,
711 a new string, without any text properties, is returned. */)
716 register unsigned char *strp
;
717 register unsigned char *bufp
;
722 unsigned char *start
;
723 int length
, length_byte
;
725 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
732 CHECK_STRING (string
);
736 GCPRO4 (string
, tem
, keymap
, name
);
738 multibyte
= STRING_MULTIBYTE (string
);
741 /* KEYMAP is either nil (which means search all the active keymaps)
742 or a specified local map (which means search just that and the
743 global map). If non-nil, it might come from Voverriding_local_map,
744 or from a \\<mapname> construct in STRING itself.. */
745 keymap
= current_kboard
->Voverriding_terminal_local_map
;
747 keymap
= Voverriding_local_map
;
749 bsize
= SBYTES (string
);
750 bufp
= buf
= (unsigned char *) xmalloc (bsize
);
752 strp
= SDATA (string
);
753 while (strp
< SDATA (string
) + SBYTES (string
))
755 if (strp
[0] == '\\' && strp
[1] == '=')
757 /* \= quotes the next character;
758 thus, to put in \[ without its special meaning, use \=\[. */
765 STRING_CHAR_AND_LENGTH (strp
, len
);
769 memcpy (bufp
, strp
, len
);
775 *bufp
++ = *strp
++, nchars
++;
777 else if (strp
[0] == '\\' && strp
[1] == '[')
780 int follow_remap
= 1;
783 strp
+= 2; /* skip \[ */
785 start_idx
= start
- SDATA (string
);
787 while ((strp
- SDATA (string
)
791 length_byte
= strp
- start
;
795 /* Save STRP in IDX. */
796 idx
= strp
- SDATA (string
);
797 name
= Fintern (make_string (start
, length_byte
), Qnil
);
800 tem
= Fwhere_is_internal (name
, keymap
, Qt
, Qnil
, Qnil
);
802 if (VECTORP (tem
) && XVECTOR (tem
)->size
> 1
803 && EQ (AREF (tem
, 0), Qremap
) && SYMBOLP (AREF (tem
, 1))
806 name
= AREF (tem
, 1);
811 /* Note the Fwhere_is_internal can GC, so we have to take
812 relocation of string contents into account. */
813 strp
= SDATA (string
) + idx
;
814 start
= SDATA (string
) + start_idx
;
816 if (NILP (tem
)) /* but not on any keys */
818 int offset
= bufp
- buf
;
819 buf
= (unsigned char *) xrealloc (buf
, bsize
+= 4);
821 memcpy (bufp
, "M-x ", 4);
825 length
= multibyte_chars_in_text (start
, length_byte
);
827 length
= length_byte
;
831 { /* function is on a key */
832 tem
= Fkey_description (tem
, Qnil
);
836 /* \{foo} is replaced with a summary of the keymap (symbol-value foo).
837 \<foo> just sets the keymap used for \[cmd]. */
838 else if (strp
[0] == '\\' && (strp
[1] == '{' || strp
[1] == '<'))
840 struct buffer
*oldbuf
;
842 /* This is for computing the SHADOWS arg for describe_map_tree. */
843 Lisp_Object active_maps
= Fcurrent_active_maps (Qnil
, Qnil
);
844 Lisp_Object earlier_maps
;
847 strp
+= 2; /* skip \{ or \< */
849 start_idx
= start
- SDATA (string
);
851 while ((strp
- SDATA (string
) < SBYTES (string
))
852 && *strp
!= '}' && *strp
!= '>')
855 length_byte
= strp
- start
;
856 strp
++; /* skip } or > */
858 /* Save STRP in IDX. */
859 idx
= strp
- SDATA (string
);
861 /* Get the value of the keymap in TEM, or nil if undefined.
862 Do this while still in the user's current buffer
863 in case it is a local variable. */
864 name
= Fintern (make_string (start
, length_byte
), Qnil
);
865 tem
= Fboundp (name
);
868 tem
= Fsymbol_value (name
);
871 tem
= get_keymap (tem
, 0, 1);
872 /* Note that get_keymap can GC. */
873 strp
= SDATA (string
) + idx
;
874 start
= SDATA (string
) + start_idx
;
878 /* Now switch to a temp buffer. */
879 oldbuf
= current_buffer
;
880 set_buffer_internal (XBUFFER (Vprin1_to_string_buffer
));
884 name
= Fsymbol_name (name
);
885 insert_string ("\nUses keymap \"");
886 insert_from_string (name
, 0, 0,
889 insert_string ("\", which is not currently defined.\n");
890 if (start
[-1] == '<') keymap
= Qnil
;
892 else if (start
[-1] == '<')
896 /* Get the list of active keymaps that precede this one.
897 If this one's not active, get nil. */
898 earlier_maps
= Fcdr (Fmemq (tem
, Freverse (active_maps
)));
899 describe_map_tree (tem
, 1, Fnreverse (earlier_maps
),
900 Qnil
, (char *)0, 1, 0, 0, 1);
902 tem
= Fbuffer_string ();
904 set_buffer_internal (oldbuf
);
908 length
= SCHARS (tem
);
909 length_byte
= SBYTES (tem
);
912 int offset
= bufp
- buf
;
913 buf
= (unsigned char *) xrealloc (buf
, bsize
+= length_byte
);
915 memcpy (bufp
, start
, length_byte
);
918 /* Check STRING again in case gc relocated it. */
919 strp
= (unsigned char *) SDATA (string
) + idx
;
922 else if (! multibyte
) /* just copy other chars */
923 *bufp
++ = *strp
++, nchars
++;
928 STRING_CHAR_AND_LENGTH (strp
, len
);
932 memcpy (bufp
, strp
, len
);
939 if (changed
) /* don't bother if nothing substituted */
940 tem
= make_string_from_bytes (buf
, nchars
, bufp
- buf
);
944 RETURN_UNGCPRO (tem
);
950 Qfunction_documentation
= intern_c_string ("function-documentation");
951 staticpro (&Qfunction_documentation
);
953 DEFVAR_LISP ("internal-doc-file-name", &Vdoc_file_name
,
954 doc
: /* Name of file containing documentation strings of built-in symbols. */);
955 Vdoc_file_name
= Qnil
;
957 DEFVAR_LISP ("build-files", &Vbuild_files
,
958 doc
: /* A list of files used to build this Emacs binary. */);
961 defsubr (&Sdocumentation
);
962 defsubr (&Sdocumentation_property
);
963 defsubr (&Ssnarf_documentation
);
964 defsubr (&Ssubstitute_command_keys
);
967 /* arch-tag: 56281d4d-6949-43e2-be2e-f6517de744ba
968 (do not change this comment) */