mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-22 07:09:54 +00:00
Backport: Remove an ambiguity from defvar's doc string. Fixes bug #25292.
The ambiguity was whether INITVALUE is evaluated when it's not going to be
used to set SYMBOL's value.
* src/eval.c (defvar): Rewrite a paragraph of the doc string.
(cherry picked from commit 8295e97f18
)
This commit is contained in:
parent
af1b1026dd
commit
e8f0d7dcad
@ -704,10 +704,11 @@ can be referred to by the Emacs help facilities and other programming
|
||||
tools. The `defvar' form also declares the variable as \"special\",
|
||||
so that it is always dynamically bound even if `lexical-binding' is t.
|
||||
|
||||
The optional argument INITVALUE is evaluated, and used to set SYMBOL,
|
||||
only if SYMBOL's value is void. If SYMBOL is buffer-local, its
|
||||
default value is what is set; buffer-local values are not affected.
|
||||
If INITVALUE is missing, SYMBOL's value is not set.
|
||||
If SYMBOL's value is void and the optional argument INITVALUE is
|
||||
provided, INITVALUE is evaluated and the result used to set SYMBOL's
|
||||
value. If SYMBOL is buffer-local, its default value is what is set;
|
||||
buffer-local values are not affected. If INITVALUE is missing,
|
||||
SYMBOL's value is not set.
|
||||
|
||||
If SYMBOL has a local binding, then this form affects the local
|
||||
binding. This is usually not what you want. Thus, if you need to
|
||||
|
Loading…
Reference in New Issue
Block a user