(File Local Variables): Do not refer to the `-*-' line as

a "local variables list".  Add pxref.
This commit is contained in:
Luc Teirlinck 2005-05-15 16:53:06 +00:00
parent 85ddb888e7
commit a191491224

View file

@ -1784,15 +1784,15 @@ foo
@section File Local Variables
This section describes the functions and variables that affect
processing of local variables lists in files. @xref{File variables, ,
processing of file local variables. @xref{File variables, ,
Local Variables in Files, emacs, The GNU Emacs Manual}, for basic
information about file local variables.
@defopt enable-local-variables
This variable controls whether to process file local variables lists. A
value of @code{t} means process the local variables lists
unconditionally; @code{nil} means ignore them; anything else means ask
the user what to do for each file. The default value is @code{t}.
This variable controls whether to process file local variables. A
value of @code{t} means process them unconditionally; @code{nil} means
ignore them; anything else means ask the user what to do for each
file. The default value is @code{t}.
@end defopt
@defun hack-local-variables &optional mode-only
@ -1801,7 +1801,7 @@ variables specified by the contents of the current buffer. The variable
@code{enable-local-variables} has its effect here. However, this
function does not look for the @samp{mode:} local variable in the
@w{@samp{-*-}} line. @code{set-auto-mode} does that, also taking
@code{enable-local-variables} into account.
@code{enable-local-variables} into account (@pxref{Auto Major Mode}).
If the optional argument @var{mode-only} is non-@code{nil}, then all
this function does is return @code{t} if the @w{@samp{-*-}} line or
@ -1809,21 +1809,21 @@ the local variables list specifies a mode and @code{nil} otherwise.
It does not set the mode nor any other file local variable.
@end defun
If a file local variable list could specify a function that would
If a file local variable could specify a function that would
be called later, or an expression that would be executed later, simply
visiting a file could take over your Emacs. To prevent this, Emacs
takes care not to allow local variable lists to set such variables.
takes care not to allow to set such file local variables.
For one thing, any variable whose name ends in @samp{-command},
@samp{-frame-alist}, @samp{-function}, @samp{-functions},
@samp{-hook}, @samp{-hooks}, @samp{-form}, @samp{-forms}, @samp{-map},
@samp{-map-alist}, @samp{-mode-alist}, @samp{-program}, or
@samp{-predicate} cannot be set in a local variable list. In general,
@samp{-predicate} cannot be given a file local value. In general,
you should use such a name whenever it is appropriate for the
variable's meaning. The variables @samp{font-lock-keywords},
@samp{font-lock-keywords-[0-9]}, and
@samp{font-lock-syntactic-keywords} cannot be set in a local variable
list, either. These rules can be overridden by giving the variable's
@samp{font-lock-syntactic-keywords} cannot be given file local values either.
These rules can be overridden by giving the variable's
name a non-@code{nil} @code{safe-local-variable} property. If one
gives it a @code{safe-local-variable} property of @code{t}, then one
can give the variable any file local value. One can also give any
@ -1838,9 +1838,9 @@ argument.
variables listed in @code{ignored-local-variables}:
@defvar ignored-local-variables
This variable holds a list of variables that should not be
set by a file's local variables list. Any value specified
for one of these variables is ignored.
This variable holds a list of variables that should not be given local
values by files. Any value specified for one of these variables is
ignored.
@end defvar
@defun risky-local-variable-p sym &optional val
@ -1855,7 +1855,8 @@ value whatsoever.
normally asks for confirmation before handling it.
@defopt enable-local-eval
This variable controls processing of @samp{Eval:} in local variables
This variable controls processing of @samp{Eval:} in @samp{-*-} lines
or local variables
lists in files being visited. A value of @code{t} means process them
unconditionally; @code{nil} means ignore them; anything else means ask
the user what to do for each file. The default value is @code{maybe}.
@ -1863,8 +1864,7 @@ the user what to do for each file. The default value is @code{maybe}.
Text properties are also potential loopholes, since their values
could include functions to call. So Emacs discards all text
properties from string values specified in a file's local variables
list.
properties from string values specified for file local variables.
@node Variables with Restricted Values
@section Variables with Restricted Values