bug#10635: 23.3; Docstring for `defcustom' fails to mention that `:safe' keyword takes a predicate.

bug#10635: 23.3; Docstring for `defcustom' fails to mention that `:safe' keyword takes a predicate.

[Samuel Bronson]

I've taken the liberty of creating a patch, in which I also fix a
`checkdoc' warning:

diff -u -L /usr/share/emacs/23.3/lisp/custom.el.gz -L /tmp/buffer-content-21867Fhg /tmp/jka-com21867Srm /tmp/buffer-content-21867Fhg
--- /usr/share/emacs/23.3/lisp/custom.el.gz
+++ /tmp/buffer-content-21867Fhg
@@ -197,7 +197,7 @@
 
 Neither SYMBOL nor VALUE need to be quoted.
 If SYMBOL is not already bound, initialize it to VALUE.
-The remaining arguments should have the form
+The remaining arguments (ARGS) should have the form
 
    [KEYWORD VALUE]...
 
@@ -222,7 +222,9 @@
 	for this option, then when your `.emacs' file loads the value,
 	it does (require VALUE) first.
 :risky	Set SYMBOL's `risky-local-variable' property to VALUE.
-:safe	Set SYMBOL's `safe-local-variable' property to VALUE.
+:safe	Set SYMBOL's `safe-local-variable' property to VALUE,
+	a predicate telling whether any given value is safe for the
+	variable.  See Info node `(elisp) File Local Variables'.
 
 The following common keywords are also meaningful.
 

Diff finished.  Sat Jan 28 19:22:47 2012


In GNU Emacs 23.3.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2011-10-25 on murphy, modified by Debian
configured using `configure  '--build' 'i486-linux-gnu' '--build' 'i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var/lib' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs23:/etc/emacs:/usr/local/share/emacs/23.3/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/23.3/site-lisp:/usr/share/emacs/site-lisp' '--with-crt-dir=/usr/lib/i386-linux-gnu' '--with-x=yes' '--with-x-toolkit=lucid' '--with-toolkit-scroll-bars' '--without-gconf' 'build_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -g -O2''

-- 
Hi! I'm a .signature virus! Copy me into your ~/.signature to help me spread!

bug#10635: 23.3; Docstring for `defcustom' fails to mention that `:safe' keyword takes a predicate.

[Chong Yidong]

Samuel Bronson <naesten@gmail.com> writes:

> I've taken the liberty of creating a patch, in which I also fix a
> `checkdoc' warning:

Thanks.  I added the manual link as you suggested, but I don't think
it's worth going into more detail than that about the
safe-local-variable property within that docstring.