aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChong Yidong2012-04-09 20:36:01 +0800
committerChong Yidong2012-04-09 20:36:01 +0800
commitb4d3bc10dc84f6b01a2b6b215d0e489555aa6edd (patch)
treeefc38746407c5604b926f192b6f1339dbac410d1 /doc
parent9e40dda4c65e2b5a3dba82c180a20bb5c4687540 (diff)
downloademacs-b4d3bc10dc84f6b01a2b6b215d0e489555aa6edd.tar.gz
emacs-b4d3bc10dc84f6b01a2b6b215d0e489555aa6edd.zip
Remove defining user variables via * in docstring.
* lisp/apropos.el (apropos-variable): * lisp/files-x.el (read-file-local-variable): * lisp/simple.el (set-variable): * lisp/woman.el (woman-mini-help): * lisp/emacs-lisp/byte-opt.el (side-effect-free-fns): Callers changed. * lisp/custom.el (custom-variable-p): Return nil for non-symbol arguments instead of signaling an error. (user-variable-p): Obsolete alias for custom-variable-p. * lisp/erc/erc.el (erc-cmd-SET): Call custom-variable-p instead of user-variable-p. * src/callint.c (Finteractive, Fcall_interactively): * src/minibuf.c (Fread_variable): Callers changed. * src/eval.c (Fuser_variable_p, user_variable_p_eh) (lisp_indirect_variable): Functions deleted. (Fdefvar): Caller changed. * doc/lispref/commands.texi (Interactive Codes): * doc/lispref/help.texi (Accessing Documentation): * doc/lispref/minibuf.texi (High-Level Completion): Callers changed. * doc/lispref/customize.texi (Variable Definitions): Remove user-variable-p.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/commands.texi2
-rw-r--r--doc/lispref/customize.texi8
-rw-r--r--doc/lispref/help.texi2
-rw-r--r--doc/lispref/minibuf.texi6
5 files changed, 13 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index afd6700ef61..81558bbd248 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,11 @@
12012-04-09 Chong Yidong <cyd@gnu.org>
2
3 * customize.texi (Variable Definitions): Remove user-variable-p.
4
5 * commands.texi (Interactive Codes):
6 * help.texi (Accessing Documentation):
7 * minibuf.texi (High-Level Completion): Callers changed.
8
12012-04-06 Chong Yidong <cyd@gnu.org> 92012-04-06 Chong Yidong <cyd@gnu.org>
2 10
3 * minibuf.texi (Programmed Completion): Document metadata method. 11 * minibuf.texi (Programmed Completion): Document metadata method.
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 617f050f498..95039d36b7e 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -482,7 +482,7 @@ discarded, @samp{U} provides @code{nil} as the argument. No I/O.
482 482
483@item v 483@item v
484A variable declared to be a user option (i.e., satisfying the 484A variable declared to be a user option (i.e., satisfying the
485predicate @code{user-variable-p}). This reads the variable using 485predicate @code{custom-variable-p}). This reads the variable using
486@code{read-variable}. @xref{Definition of read-variable}. Existing, 486@code{read-variable}. @xref{Definition of read-variable}. Existing,
487Completion, Prompt. 487Completion, Prompt.
488 488
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi
index 4c3adee0db5..d86aea24fbc 100644
--- a/doc/lispref/customize.texi
+++ b/doc/lispref/customize.texi
@@ -462,14 +462,6 @@ meaning it was declared with @code{defcustom}), or an alias for
462another customizable variable. 462another customizable variable.
463@end defun 463@end defun
464 464
465@defun user-variable-p arg
466This function is like @code{custom-variable-p}, except it also returns
467@code{t} if the first character of the variable's documentation string
468is the character @samp{*}. That is an obsolete way of indicating a
469user option, so for most purposes you may consider
470@code{user-variable-p} as equivalent to @code{custom-variable-p}.
471@end defun
472
473@node Customization Types 465@node Customization Types
474@section Customization Types 466@section Customization Types
475 467
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 537514d7fb9..c703e7810f8 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -218,7 +218,7 @@ in the `*Help*' buffer."
218@group 218@group
219 (princ 219 (princ
220 (format "%s\t%s\n%s\n\n" s 220 (format "%s\t%s\n%s\n\n" s
221 (if (user-variable-p s) 221 (if (custom-variable-p s)
222 "Option " "Variable") 222 "Option " "Variable")
223@end group 223@end group
224@group 224@group
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 4e11bc30d49..437a2daa8e3 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -1313,17 +1313,17 @@ If the user then types @kbd{fill-p @key{RET}}, @code{read-variable}
1313returns @code{fill-prefix}. 1313returns @code{fill-prefix}.
1314 1314
1315In general, @code{read-variable} is similar to @code{read-command}, 1315In general, @code{read-variable} is similar to @code{read-command},
1316but uses the predicate @code{user-variable-p} instead of 1316but uses the predicate @code{custom-variable-p} instead of
1317@code{commandp}: 1317@code{commandp}:
1318 1318
1319@cindex @code{user-variable-p} example 1319@cindex @code{custom-variable-p} example
1320@example 1320@example
1321@group 1321@group
1322(read-variable @var{prompt}) 1322(read-variable @var{prompt})
1323@equiv{} 1323@equiv{}
1324(intern 1324(intern
1325 (completing-read @var{prompt} obarray 1325 (completing-read @var{prompt} obarray
1326 'user-variable-p t nil)) 1326 'custom-variable-p t nil))
1327@end group 1327@end group
1328@end example 1328@end example
1329@end defun 1329@end defun