]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of safe values of variables
authorEli Zaretskii <eliz@gnu.org>
Sat, 13 Jan 2018 10:48:07 +0000 (12:48 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 13 Jan 2018 10:48:07 +0000 (12:48 +0200)
* doc/lispref/variables.texi (File Local Variables): Mention the
autoload cookie as a means of defining safe values for variables.
See http://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00261.html
for the details.
* doc/lispref/compile.texi (Compiler Errors): Document
'byte-compile-error-on-warn'.

doc/lispref/compile.texi
doc/lispref/variables.texi

index 32162c9c22b9c85deb19e77457e8176a9bbe1c99..212b5a45dc692b100eaca86464a5164da2f4fa3b 100644 (file)
@@ -524,6 +524,11 @@ one you intend to suppress.
 the variable @code{byte-compile-warnings}.  See its documentation
 string for details.
 
+@vindex byte-compile-error-on-warn
+  Sometimes you may wish the byte-compiler warnings to be reported
+using @code{error}.  If so, set @code{byte-compile-error-on-warn} to a
+non-nil value.
+
 @node Byte-Code Objects
 @section Byte-Code Function Objects
 @cindex compiled function
index 01cacb0b23c9de3b0d75482cbdb3d9e4356b5ca6..fe69b7b8e7bcec6c1a67f4602874f1c89a2ff2fe 100644 (file)
@@ -1811,10 +1811,23 @@ variables have @code{safe-local-variable} properties; these include
 For boolean-valued variables that are safe, use @code{booleanp} as the
 property value.
 
+@cindex autoload cookie, and safe values of variable
   When defining a user option using @code{defcustom}, you can set its
 @code{safe-local-variable} property by adding the arguments
 @code{:safe @var{function}} to @code{defcustom} (@pxref{Variable
-Definitions}).
+Definitions}).  However, a safety predicate defined using @code{:safe}
+will only be known once the byte-compiler is loaded.  As an
+alternative, you can use the autoload cookie (@pxref{Autoload}) to
+assign the option its safety predicate, like this:
+
+@lisp
+;;;###autoload (put '@var{var} 'safe-local-variable '@var{pred})
+@end lisp
+
+@noindent
+The safe value definitions specified with @code{autoload} are copied
+into the @file{loaddefs.el} file, and are known to Emacs since the
+beginning of a session.
 
 @defopt safe-local-variable-values
 This variable provides another way to mark some variable values as