Improvements to `(emacs)File Variables'

[Reiner Steib]

Hi,

`unibyte: t' is not mentioned at all in (info "(emacs)File Variables").

Additionally, the paragraph starting with »Two "variable names" have
special meanings ...« is misleading because beside `mode' and `eval'
also `unibyte' and `coding' have special meanings:

,----[ (info "(emacs)File Variables") ]
|    Two "variable names" have special meanings in a local variables
| list: a value for the variable `mode' really sets the major mode, and a
| value for the variable `eval' is simply evaluated as an expression and
| the value is ignored.  `mode' and `eval' are not real variables;
`----

How about the following patches?  Okay to install?

2004-11-14  Reiner Steib  <address@hidden>

        * custom.texi (File Variables): Add `unibyte' and make it more
        clear that `unibyte' and `coding' are special.  Suggested by Simon
        Krahnke <address@hidden>.

        * mule.texi (Enabling Multibyte): Refer to File Variables.
        Suggested by Simon Krahnke <address@hidden>.

--8<---------------cut here---------------start------------->8---
--- custom.texi 21 Sep 2004 12:47:25 +0200      1.67
+++ custom.texi 14 Nov 2004 19:39:36 +0100      
@@ -961,7 +961,8 @@
   You can also specify the coding system for a file in this way: just
 specify a value for the ``variable'' named @code{coding}.  The ``value''
 must be a coding system name that Emacs recognizes.  @xref{Coding
-Systems}.
+Systems}.  @address@hidden: t}} specifies unibyte loading for a
+particular Lisp file.  @xref{Enabling Multibyte}.
 
   The @code{eval} pseudo-variable, described below, can be specified in
 the first line as well.
@@ -1022,14 +1023,15 @@
 # End:
 @end example
 
-  Two ``variable names'' have special meanings in a local variables
+  Some ``variable names'' have special meanings in a local variables
 list: a value for the variable @code{mode} really sets the major mode,
 and a value for the variable @code{eval} is simply evaluated as an
-expression and the value is ignored.  @code{mode} and @code{eval} are
-not real variables; setting variables named @code{mode} and @code{eval}
-in any other context has no special meaning.  @emph{If @code{mode} is
-used to set a major mode, it should be the first ``variable'' in the
-list.}  Otherwise, the entries that precede it in the list of the local
+expression and the value is ignored.  @code{coding}, @code{unibyte},
address@hidden and @code{eval} are not real variables; setting variables
+named @code{coding}, @code{unibyte}, @code{mode} and @code{eval} in any
+other context has no special meaning.  @emph{If @code{mode} is used to
+set a major mode, it should be the first ``variable'' in the list.}
+Otherwise, the entries that precede it in the list of the local
 variables are likely to be ignored, since most modes kill all local
 variables as part of their initialization.
--8<---------------cut here---------------end--------------->8---

(Not reformatted yet to make the change more clear:)
--8<---------------cut here---------------start------------->8---
--- mule.texi   04 Mar 2004 18:23:24 +0100      1.68
+++ mule.texi   14 Nov 2004 19:52:46 +0100      
@@ -199,7 +199,8 @@
 file, @file{.emacs}, and the initialization files of Emacs packages
 such as Gnus.  However, you can specify unibyte loading for a
 particular Lisp file, by putting @address@hidden: t;-*-}} in a
-comment on the first line.  Then that file is always loaded as unibyte
+comment on the first line (@xpref{File Variables}).
+Then that file is always loaded as unibyte
 text, even if you did not start Emacs with @samp{--unibyte}.  The
 motivation for these conventions is that it is more reliable to always
 load any particular Lisp file in the same way.  However, you can load
--8<---------------cut here---------------end--------------->8---

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/