From: Eli Zaretskii Date: Sat, 7 Jan 2023 13:25:11 +0000 (+0200) Subject: ; Fix documentation of etc/DOC X-Git-Tag: emacs-29.0.90~811 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e9341119fe462c53b1f8d6650a3b6729a0728a0a;p=emacs.git ; Fix documentation of etc/DOC * doc/lispref/help.texi (Documentation Basics): Doc strings of preloaded symbols are no longer in etc/DOC. --- diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index de5ed76c7f7..d902113122f 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -69,14 +69,14 @@ Variables}. The string is stored in the variable's @cindex @file{DOC} (documentation) file Sometimes, Emacs does not keep documentation strings in memory. There are two such circumstances. Firstly, to save memory, the -documentation for preloaded functions and variables (including -primitives) is kept in a file named @file{DOC}, in the directory -specified by @code{doc-directory} (@pxref{Accessing Documentation}). -Secondly, when a function or variable is loaded from a byte-compiled -file, Emacs avoids loading its documentation string (@pxref{Docs and -Compilation}). In both cases, Emacs looks up the documentation string -from the file only when needed, such as when the user calls @kbd{C-h -f} (@code{describe-function}) for a function. +documentation for primitive functions (@pxref{What Is a Function}) and +built-in variables is kept in a file named @file{DOC}, in the +directory specified by @code{doc-directory} (@pxref{Accessing +Documentation}). Secondly, when a function or variable is loaded from +a byte-compiled file, Emacs avoids loading its documentation string +(@pxref{Docs and Compilation}). In both cases, Emacs looks up the +documentation string from the file only when needed, such as when the +user calls @kbd{C-h f} (@code{describe-function}) for a function. Documentation strings can contain special @dfn{key substitution sequences}, referring to key bindings which are looked up only when