procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Fix documentation of etc/DOC

Browse source 
* doc/lispref/help.texi (Documentation Basics): Doc strings of
preloaded symbols are no longer in etc/DOC.
This commit is contained in:
Eli Zaretskii 2023-01-07 15:25:11 +02:00
parent 86a3462e3d
commit e9341119fe
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/lispref/help.texi
View file

@ -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