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

Backport: Remove an ambiguity from defvar's doc string. Fixes bug #25292.

Browse source 
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:
Alan Mackenzie 2016-12-29 20:52:02 +00:00
parent af1b1026dd
commit e8f0d7dcad
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/eval.c
View file

@ -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\", tools. The `defvar' form also declares the variable as \"special\",
so that it is always dynamically bound even if `lexical-binding' is t. so that it is always dynamically bound even if `lexical-binding' is t.
The optional argument INITVALUE is evaluated, and used to set SYMBOL, If SYMBOL's value is void and the optional argument INITVALUE is
only if SYMBOL's value is void. If SYMBOL is buffer-local, its provided, INITVALUE is evaluated and the result used to set SYMBOL's
default value is what is set; buffer-local values are not affected. value. If SYMBOL is buffer-local, its default value is what is set;
If INITVALUE is missing, SYMBOL's value is not 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 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 binding. This is usually not what you want. Thus, if you need to