[Emacs-diffs] /srv/bzr/emacs/trunk r106901: Document inhibit-local-variables-regexps in the lispref.

[Glenn Morris]

------------------------------------------------------------
revno: 106901
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Fri 2012-01-20 19:15:07 -0800
message:
  Document inhibit-local-variables-regexps in the lispref.
  
  * doc/lispref/modes.texi (Auto Major Mode):
  * doc/lispref/variables.texi (File Local Variables):
  Mention inhibit-local-variables-regexps.
  
  * etc/NEWS: Markup.
modified:
  doc/lispref/ChangeLog
  doc/lispref/modes.texi
  doc/lispref/variables.texi
  etc/NEWS

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-01-19 10:38:31 +0000
+++ b/doc/lispref/ChangeLog     2012-01-21 03:15:07 +0000
@@ -1,3 +1,9 @@
+2012-01-21  Glenn Morris  <address@hidden>
+
+       * modes.texi (Auto Major Mode):
+       * variables.texi (File Local Variables):
+       Mention inhibit-local-variables-regexps.
+
 2012-01-19  Martin Rudalics  <address@hidden>
 
        * windows.texi (Window Configurations): Rewrite references to

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2012-01-19 07:21:25 +0000
+++ b/doc/lispref/modes.texi    2012-01-21 03:15:07 +0000
@@ -588,6 +588,18 @@
 is @code{nil}, @code{set-auto-mode} does not check the @address@hidden
 line, or near the end of the file, for any mode tag.
 
address@hidden inhibit-local-variables-regexps
+There are some file types where it is not appropriate to scan the file
+contents for a mode specifier.  For example, a tar archive may happen to
+contain, near the end of the file, a member file that has a local
+variables section specifying a mode for that particular file.  This
+should not be applied to the containing tar file.  Similarly, a tiff
+image file might just happen to contain a first line that seems to
+match the @address@hidden pattern.  For these reasons, both these file
+extensions are members of the list @var{inhibit-local-variables-regexps}.
+Add patterns to this list to prevent Emacs searching them for local
+variables of any kind (not just mode specifiers).
+
 If @var{keep-mode-if-same} is address@hidden, this function does not
 call the mode command if the buffer is already in the proper major
 mode.  For instance, @code{set-visited-file-name} sets this to

=== modified file 'doc/lispref/variables.texi'
--- a/doc/lispref/variables.texi        2012-01-19 07:21:25 +0000
+++ b/doc/lispref/variables.texi        2012-01-21 03:15:07 +0000
@@ -1660,6 +1660,13 @@
 @end table
 @end defopt
 
address@hidden inhibit-local-variables-regexps
+This is a list of regular expressions.  If a file has a name
+matching an element of this list, then it is not scanned for
+any form of file-local variable.  For examples of why you might want
+to use this, @pxref{Auto Major Mode}.
address@hidden defvar
+
 @defun hack-local-variables &optional mode-only
 This function parses, and binds or evaluates as appropriate, any local
 variables specified by the contents of the current buffer.  The variable

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2012-01-21 00:41:05 +0000
+++ b/etc/NEWS  2012-01-21 03:15:07 +0000
@@ -369,8 +369,7 @@
 *** Using "mode: MINOR-MODE" to enable a minor mode is deprecated.
 Instead, use "eval: (minor-mode 1)".
 
-FIXME: inhibit-first-line-modes-regexps was not mentioned in lispref,
-but this probably should be.
++++
 *** The variable `inhibit-first-line-modes-regexps' has been renamed
 to `inhibit-local-variables-regexps'.  As the name suggests, it now
 applies to ALL file local variables, not just -*- mode ones.