emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] /srv/bzr/emacs/emacs-24 r110981: Lisp manual improvements


From: Chong Yidong
Subject: [Emacs-diffs] /srv/bzr/emacs/emacs-24 r110981: Lisp manual improvements for plists and symbol plists.
Date: Sun, 02 Dec 2012 17:14:16 +0800
User-agent: Bazaar (2.5.0)

------------------------------------------------------------
revno: 110981
committer: Chong Yidong <address@hidden>
branch nick: emacs-24
timestamp: Sun 2012-12-02 17:14:16 +0800
message:
  Lisp manual improvements for plists and symbol plists.
  
  * doc/lispref/commands.texi (Using Interactive): Fix index entry.
  
  * doc/lispref/customize.texi (Variable Definitions):
  * doc/lispref/display.texi (Defining Faces):
  * doc/lispref/sequences.texi (Char-Tables): Fix xref.
  
  * doc/lispref/lists.texi (Property Lists): Move here from symbols.texi.
  (Plist Access): Rename from Other Plists.
  
  * doc/lispref/symbols.texi (Symbol Properties): New node.
  (Symbol Plists): Make it a subsection under Symbol Properties.
  (Standard Properties): New node.
modified:
  doc/lispref/ChangeLog
  doc/lispref/commands.texi
  doc/lispref/customize.texi
  doc/lispref/display.texi
  doc/lispref/elisp.texi
  doc/lispref/lists.texi
  doc/lispref/sequences.texi
  doc/lispref/symbols.texi
  doc/lispref/variables.texi
=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-12-02 07:13:44 +0000
+++ b/doc/lispref/ChangeLog     2012-12-02 09:14:16 +0000
@@ -1,7 +1,20 @@
 2012-12-02  Chong Yidong  <address@hidden>
 
+       * symbols.texi (Symbol Properties): New node.
+       (Symbol Plists): Make it a subsection under Symbol Properties.
+       (Standard Properties): New node.
+
+       * lists.texi (Property Lists): Move here from symbols.texi.
+       (Plist Access): Rename from Other Plists.
+
+       * customize.texi (Variable Definitions):
+       * display.texi (Defining Faces):
+       * sequences.texi (Char-Tables): Fix xref.
+
        * keymaps.texi (Key Sequences): kbd is now a function.
 
+       * commands.texi (Using Interactive): Fix index entry.
+
 2012-11-23  Martin Rudalics  <address@hidden>
 
        * windows.texi (Basic Windows): Fix typo.

=== modified file 'doc/lispref/commands.texi'
--- a/doc/lispref/commands.texi 2012-10-27 05:03:52 +0000
+++ b/doc/lispref/commands.texi 2012-12-02 09:14:16 +0000
@@ -141,10 +141,10 @@
 then the caller supplies the arguments and @var{arg-descriptor} has no
 effect.
 
address@hidden @code{interactive-form}, function property
address@hidden @code{interactive-form}, symbol property
 The @code{interactive} form must be located at top-level in the
 function body, or in the function symbol's @code{interactive-form}
-property (@pxref{Symbol Plists}).  It has its effect because the
+property (@pxref{Symbol Properties}).  It has its effect because the
 command loop looks for it before calling the function
 (@pxref{Interactive Call}).  Once the function is called, all its body
 forms are executed; at this time, if the @code{interactive} form

=== modified file 'doc/lispref/customize.texi'
--- a/doc/lispref/customize.texi        2012-09-18 05:14:42 +0000
+++ b/doc/lispref/customize.texi        2012-12-02 09:14:16 +0000
@@ -472,8 +472,8 @@
 @code{saved-value} to record the value saved by the user with the
 customization buffer, and @code{customized-value} to record the value
 set by the user with the customization buffer, but not saved.
address@hidden Lists}.  These properties are lists, the car of which
-is an expression that evaluates to the value.
address@hidden Properties}.  These properties are lists, the car of
+which is an expression that evaluates to the value.
 
 @defun custom-reevaluate-setting symbol
 This function re-evaluates the standard value of @var{symbol}, which

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2012-11-17 02:29:58 +0000
+++ b/doc/lispref/display.texi  2012-12-02 09:14:16 +0000
@@ -2287,7 +2287,7 @@
 @end example
 
   Internally, Emacs stores the face's default specification in its
address@hidden symbol property (@pxref{Property Lists}).
address@hidden symbol property (@pxref{Symbol Properties}).
 The @code{saved-face} property stores the face specification saved by
 the user, using the customization buffer; the @code{customized-face}
 property stores the face specification customized for the current

=== modified file 'doc/lispref/elisp.texi'
--- a/doc/lispref/elisp.texi    2012-11-20 08:02:54 +0000
+++ b/doc/lispref/elisp.texi    2012-12-02 09:14:16 +0000
@@ -378,6 +378,7 @@
 * Modifying Lists::         Storing new pieces into an existing list.
 * Sets And Lists::          A list can represent a finite mathematical set.
 * Association Lists::       A list can represent a finite relation or mapping.
+* Property Lists::          A list of paired elements.
 
 Modifying Existing List Structure
 
@@ -386,6 +387,12 @@
                               This can be used to remove or add elements.
 * Rearrangement::           Reordering the elements in a list; combining lists.
 
+Property Lists
+
+* Plists and Alists::       Comparison of the advantages of property
+                              lists and association lists.
+* Plist Access::            Accessing property lists stored elsewhere.
+
 Sequences, Arrays, and Vectors
 
 * Sequence Functions::      Functions that accept any kind of sequence.
@@ -410,15 +417,13 @@
                               and property lists.
 * Definitions::             A definition says how a symbol will be used.
 * Creating Symbols::        How symbols are kept unique.
-* Property Lists::          Each symbol has a property list
+* Symbol Properties::       Each symbol has a property list
                               for recording miscellaneous information.
 
-Property Lists
+Symbol Properties
 
-* Plists and Alists::       Comparison of the advantages of property
-                              lists and association lists.
-* Symbol Plists::           Functions to access symbols' property lists.
-* Other Plists::            Accessing property lists stored elsewhere.
+* Symbol Plists::           Accessing symbol properties.
+* Standard Properties::     Standard meanings of symbol properties.
 
 Evaluation
 

=== modified file 'doc/lispref/lists.texi'
--- a/doc/lispref/lists.texi    2012-11-07 05:22:10 +0000
+++ b/doc/lispref/lists.texi    2012-12-02 09:14:16 +0000
@@ -22,6 +22,7 @@
 * Modifying Lists::     Storing new pieces into an existing list.
 * Sets And Lists::      A list can represent a finite mathematical set.
 * Association Lists::   A list can represent a finite relation or mapping.
+* Property Lists::      A list of paired elements.
 @end menu
 
 @node Cons Cells
@@ -1821,3 +1822,142 @@
 compares the @sc{cdr} of each @var{alist} association instead of the
 @sc{car}.
 @end defun
+
address@hidden Property Lists
address@hidden Property Lists
address@hidden property list
address@hidden plist
+
+  A @dfn{property list} (@dfn{plist} for short) is a list of paired
+elements.  Each of the pairs associates a property name (usually a
+symbol) with a property or value.  Here is an example of a property
+list:
+
address@hidden
+(pine cones numbers (1 2 3) color "blue")
address@hidden example
+
address@hidden
+This property list associates @code{pine} with @code{cones},
address@hidden with @code{(1 2 3)}, and @code{color} with
address@hidden"blue"}.  The property names and values can be any Lisp objects,
+but the names are usually symbols (as they are in this example).
+
+  Property lists are used in several contexts.  For instance, the
+function @code{put-text-property} takes an argument which is a
+property list, specifying text properties and associated values which
+are to be applied to text in a string or buffer.  @xref{Text
+Properties}.
+
+  Another prominent use of property lists is for storing symbol
+properties.  Every symbol possesses a list of properties, used to
+record miscellaneous information about the symbol; these properties
+are stored in the form of a property list.  @xref{Symbol Properties}.
+
address@hidden
+* Plists and Alists::           Comparison of the advantages of property
+                                  lists and association lists.
+* Plist Access::                Accessing property lists stored elsewhere.
address@hidden menu
+
address@hidden Plists and Alists
address@hidden Property Lists and Association Lists
address@hidden plist vs. alist
address@hidden alist vs. plist
+
address@hidden property lists vs association lists
+  Association lists (@pxref{Association Lists}) are very similar to
+property lists.  In contrast to association lists, the order of the
+pairs in the property list is not significant, since the property
+names must be distinct.
+
+  Property lists are better than association lists for attaching
+information to various Lisp function names or variables.  If your
+program keeps all such information in one association list, it will
+typically need to search that entire list each time it checks for an
+association for a particular Lisp function name or variable, which
+could be slow.  By contrast, if you keep the same information in the
+property lists of the function names or variables themselves, each
+search will scan only the length of one property list, which is
+usually short.  This is why the documentation for a variable is
+recorded in a property named @code{variable-documentation}.  The byte
+compiler likewise uses properties to record those functions needing
+special treatment.
+
+  However, association lists have their own advantages.  Depending on
+your application, it may be faster to add an association to the front of
+an association list than to update a property.  All properties for a
+symbol are stored in the same property list, so there is a possibility
+of a conflict between different uses of a property name.  (For this
+reason, it is a good idea to choose property names that are probably
+unique, such as by beginning the property name with the program's usual
+name-prefix for variables and functions.)  An association list may be
+used like a stack where associations are pushed on the front of the list
+and later discarded; this is not possible with a property list.
+
address@hidden Plist Access
address@hidden Property Lists Outside Symbols
+
+  The following functions can be used to manipulate property lists.
+They all compare property names using @code{eq}.
+
address@hidden plist-get plist property
+This returns the value of the @var{property} property stored in the
+property list @var{plist}.  It accepts a malformed @var{plist}
+argument.  If @var{property} is not found in the @var{plist}, it
+returns @code{nil}.  For example,
+
address@hidden
+(plist-get '(foo 4) 'foo)
+     @result{} 4
+(plist-get '(foo 4 bad) 'foo)
+     @result{} 4
+(plist-get '(foo 4 bad) 'bad)
+     @result{} nil
+(plist-get '(foo 4 bad) 'bar)
+     @result{} nil
address@hidden example
address@hidden defun
+
address@hidden plist-put plist property value
+This stores @var{value} as the value of the @var{property} property in
+the property list @var{plist}.  It may modify @var{plist} destructively,
+or it may construct a new list structure without altering the old.  The
+function returns the modified property list, so you can store that back
+in the place where you got @var{plist}.  For example,
+
address@hidden
+(setq my-plist '(bar t foo 4))
+     @result{} (bar t foo 4)
+(setq my-plist (plist-put my-plist 'foo 69))
+     @result{} (bar t foo 69)
+(setq my-plist (plist-put my-plist 'quux '(a)))
+     @result{} (bar t foo 69 quux (a))
address@hidden example
address@hidden defun
+
+  You could define @code{put} in terms of @code{plist-put} as follows:
+
address@hidden
+(defun put (symbol prop value)
+  (setplist symbol
+            (plist-put (symbol-plist symbol) prop value)))
address@hidden example
+
address@hidden lax-plist-get plist property
+Like @code{plist-get} except that it compares properties
+using @code{equal} instead of @code{eq}.
address@hidden defun
+
address@hidden lax-plist-put plist property value
+Like @code{plist-put} except that it compares properties
+using @code{equal} instead of @code{eq}.
address@hidden defun
+
address@hidden plist-member plist property
+This returns address@hidden if @var{plist} contains the given
address@hidden  Unlike @code{plist-get}, this allows you to distinguish
+between a missing property and a property with the value @code{nil}.
+The value is actually the tail of @var{plist} whose @code{car} is
address@hidden
address@hidden defun

=== modified file 'doc/lispref/sequences.texi'
--- a/doc/lispref/sequences.texi        2012-05-27 01:34:14 +0000
+++ b/doc/lispref/sequences.texi        2012-12-02 09:14:16 +0000
@@ -542,10 +542,10 @@
 @item
 The subtype controls the number of @dfn{extra slots} in the
 char-table.  This number is specified by the subtype's
address@hidden symbol property, which should be an
-integer between 0 and 10.  If the subtype has no such symbol property,
-the char-table has no extra slots.  @xref{Property Lists}, for
-information about symbol properties.
address@hidden symbol property (@pxref{Symbol
+Properties}), whose value should be an integer between 0 and 10.  If
+the subtype has no such symbol property, the char-table has no extra
+slots.
 @end itemize
 
 @cindex parent of char-table

=== modified file 'doc/lispref/symbols.texi'
--- a/doc/lispref/symbols.texi  2012-10-30 00:29:37 +0000
+++ b/doc/lispref/symbols.texi  2012-12-02 09:14:16 +0000
@@ -13,8 +13,8 @@
 @ref{Functions}.  For the precise read syntax for symbols, see
 @ref{Symbol Type}.
 
-  You can test whether an arbitrary Lisp object is a symbol
-with @code{symbolp}:
+  You can test whether an arbitrary Lisp object is a symbol with
address@hidden:
 
 @defun symbolp object
 This function returns @code{t} if @var{object} is a symbol, @code{nil}
@@ -26,7 +26,7 @@
                                and property lists.
 * Definitions::              A definition says how a symbol will be used.
 * Creating Symbols::         How symbols are kept unique.
-* Property Lists::           Each symbol has a property list
+* Symbol Properties::        Each symbol has a property list
                                for recording miscellaneous information.
 @end menu
 
@@ -91,7 +91,7 @@
 
   The property list cell normally should hold a correctly formatted
 property list.  To get a symbol's property list, use the function
address@hidden  @xref{Property Lists}.
address@hidden  @xref{Symbol Properties}.
 
   The function cell or the value cell may be @dfn{void}, which means
 that the cell does not reference any object.  (This is not the same
@@ -376,109 +376,34 @@
 it returns @code{nil}.
 @end defun
 
address@hidden Property Lists
address@hidden Property Lists
address@hidden property list
address@hidden plist
-
-  A @dfn{property list} (@dfn{plist} for short) is a list of paired
-elements.  Each of the pairs associates a property name (usually a
-symbol) with a property or value.
-
-  Every symbol has a cell that stores a property list (@pxref{Symbol
-Components}).  This property list is used to record information about
-the symbol, such as its variable documentation and the name of the
-file where it was defined.
-
-  Property lists can also be used in other contexts.  For instance,
-you can assign property lists to character positions in a string or
-buffer.  @xref{Text Properties}.
-
-  The property names and values in a property list can be any Lisp
-objects, but the names are usually symbols.  Property list functions
-compare the property names using @code{eq}.  Here is an example of a
-property list, found on the symbol @code{progn} when the compiler is
-loaded:
-
address@hidden
-(lisp-indent-function 0 byte-compile byte-compile-progn)
address@hidden example
-
address@hidden
-Here @code{lisp-indent-function} and @code{byte-compile} are property
-names, and the other two elements are the corresponding values.
address@hidden Symbol Properties
address@hidden Symbol Properties
address@hidden symbol property
+
+  A symbol may possess any number of @dfn{symbol properties}, which
+can be used to record miscellaneous information about the symbol.  For
+example, when a symbol has a @code{risky-local-variable} property with
+a address@hidden value, that means the variable which the symbol names
+is a risky file-local variable (@pxref{File Local Variables}).
+
+  Each symbol's properties and property values are stored in the
+symbol's property list cell (@pxref{Symbol Components}), in the form
+of a property list (@pxref{Property Lists}).
 
 @menu
-* Plists and Alists::           Comparison of the advantages of property
-                                  lists and association lists.
-* Symbol Plists::               Functions to access symbols' property lists.
-* Other Plists::                Accessing property lists stored elsewhere.
+* Symbol Plists::        Accessing symbol properties.
+* Standard Properties::  Standard meanings of symbol properties.
 @end menu
 
address@hidden Plists and Alists
address@hidden Property Lists and Association Lists
address@hidden plist vs. alist
address@hidden alist vs. plist
-
address@hidden property lists vs association lists
-  Association lists (@pxref{Association Lists}) are very similar to
-property lists.  In contrast to association lists, the order of the
-pairs in the property list is not significant since the property names
-must be distinct.
-
-  Property lists are better than association lists for attaching
-information to various Lisp function names or variables.  If your
-program keeps all such information in one association list, it will
-typically need to search that entire list each time it checks for an
-association for a particular Lisp function name or variable, which
-could be slow.  By contrast, if you keep the same information in the
-property lists of the function names or variables themselves, each
-search will scan only the length of one property list, which is
-usually short.  This is why the documentation for a variable is
-recorded in a property named @code{variable-documentation}.  The byte
-compiler likewise uses properties to record those functions needing
-special treatment.
-
-  However, association lists have their own advantages.  Depending on
-your application, it may be faster to add an association to the front of
-an association list than to update a property.  All properties for a
-symbol are stored in the same property list, so there is a possibility
-of a conflict between different uses of a property name.  (For this
-reason, it is a good idea to choose property names that are probably
-unique, such as by beginning the property name with the program's usual
-name-prefix for variables and functions.)  An association list may be
-used like a stack where associations are pushed on the front of the list
-and later discarded; this is not possible with a property list.
-
 @node Symbol Plists
address@hidden Property List Functions for Symbols
-
address@hidden symbol-plist symbol
-This function returns the property list of @var{symbol}.
address@hidden defun
-
address@hidden setplist symbol plist
-This function sets @var{symbol}'s property list to @var{plist}.
-Normally, @var{plist} should be a well-formed property list, but this is
-not enforced.  The return value is @var{plist}.
-
address@hidden
-(setplist 'foo '(a 1 b (2 3) c nil))
-     @result{} (a 1 b (2 3) c nil)
-(symbol-plist 'foo)
-     @result{} (a 1 b (2 3) c nil)
address@hidden example
-
-For symbols in special obarrays, which are not used for ordinary
-purposes, it may make sense to use the property list cell in a
-nonstandard fashion; in fact, the abbrev mechanism does so
-(@pxref{Abbrevs}).
address@hidden defun
address@hidden Accessing Symbol Properties
+
+  The following functions can be used to access symbol properties.
 
 @defun get symbol property
-This function finds the value of the property named @var{property} in
address@hidden's property list.  If there is no such property, @code{nil}
-is returned.  Thus, there is no distinction between a value of
+This function returns the value of the property named @var{property}
+in @var{symbol}'s property list.  If there is no such property, it
+returns @code{nil}.  Thus, there is no distinction between a value of
 @code{nil} and the absence of the property.
 
 The name @var{property} is compared with the existing property names
@@ -487,12 +412,6 @@
 See @code{put} for an example.
 @end defun
 
address@hidden function-get symbol property
-This function is identical to @code{get}, except that if @var{symbol}
-is the name of a function alias, it looks in the property list of the
-symbol naming the actual function.  @xref{Defining Functions}.
address@hidden defun
-
 @defun put symbol property value
 This function puts @var{value} onto @var{symbol}'s property list under
 the property name @var{property}, replacing any previous property value.
@@ -510,69 +429,132 @@
 @end example
 @end defun
 
address@hidden Other Plists
address@hidden Property Lists Outside Symbols
-
-  These functions are useful for manipulating property lists
-not stored in symbols:
-
address@hidden plist-get plist property
-This returns the value of the @var{property} property stored in the
-property list @var{plist}.  It accepts a malformed @var{plist}
-argument.  If @var{property} is not found in the @var{plist}, it
-returns @code{nil}.  For example,
-
address@hidden
-(plist-get '(foo 4) 'foo)
-     @result{} 4
-(plist-get '(foo 4 bad) 'foo)
-     @result{} 4
-(plist-get '(foo 4 bad) 'bad)
-     @result{} nil
-(plist-get '(foo 4 bad) 'bar)
-     @result{} nil
address@hidden example
address@hidden defun
-
address@hidden plist-put plist property value
-This stores @var{value} as the value of the @var{property} property in
-the property list @var{plist}.  It may modify @var{plist} destructively,
-or it may construct a new list structure without altering the old.  The
-function returns the modified property list, so you can store that back
-in the place where you got @var{plist}.  For example,
-
address@hidden
-(setq my-plist '(bar t foo 4))
-     @result{} (bar t foo 4)
-(setq my-plist (plist-put my-plist 'foo 69))
-     @result{} (bar t foo 69)
-(setq my-plist (plist-put my-plist 'quux '(a)))
-     @result{} (bar t foo 69 quux (a))
address@hidden example
address@hidden defun
-
-  You could define @code{put} in terms of @code{plist-put} as follows:
-
address@hidden
-(defun put (symbol prop value)
-  (setplist symbol
-            (plist-put (symbol-plist symbol) prop value)))
address@hidden example
-
address@hidden lax-plist-get plist property
-Like @code{plist-get} except that it compares properties
-using @code{equal} instead of @code{eq}.
address@hidden defun
-
address@hidden lax-plist-put plist property value
-Like @code{plist-put} except that it compares properties
-using @code{equal} instead of @code{eq}.
address@hidden defun
-
address@hidden plist-member plist property
-This returns address@hidden if @var{plist} contains the given
address@hidden  Unlike @code{plist-get}, this allows you to distinguish
-between a missing property and a property with the value @code{nil}.
-The value is actually the tail of @var{plist} whose @code{car} is
address@hidden
address@hidden defun
address@hidden symbol-plist symbol
+This function returns the property list of @var{symbol}.
address@hidden defun
+
address@hidden setplist symbol plist
+This function sets @var{symbol}'s property list to @var{plist}.
+Normally, @var{plist} should be a well-formed property list, but this is
+not enforced.  The return value is @var{plist}.
+
address@hidden
+(setplist 'foo '(a 1 b (2 3) c nil))
+     @result{} (a 1 b (2 3) c nil)
+(symbol-plist 'foo)
+     @result{} (a 1 b (2 3) c nil)
address@hidden example
+
+For symbols in special obarrays, which are not used for ordinary
+purposes, it may make sense to use the property list cell in a
+nonstandard fashion; in fact, the abbrev mechanism does so
+(@pxref{Abbrevs}).
address@hidden defun
+
address@hidden function-get symbol property
+This function is identical to @code{get}, except that if @var{symbol}
+is the name of a function alias, it looks in the property list of the
+symbol naming the actual function.  @xref{Defining Functions}.
address@hidden defun
+
address@hidden Standard Properties
address@hidden Standard Symbol Properties
+
+  Here, we list the symbol properties which are used for special
+purposes in Emacs.  In the following table, whenever we say ``the
+named function'', that means the function whose name is the relevant
+symbol; similarly for ``the named variable'' etc.
+
address@hidden @code
address@hidden :advertised-binding
+This property value specifies the preferred key binding, when showing
+documentation, for the named function.  @xref{Keys in Documentation}.
+
address@hidden char-table-extra-slots
+The value, if address@hidden, specifies the number of extra slots in
+the named char-table type.  @xref{Char-Tables}.
+
address@hidden customized-face
address@hidden face-defface-spec
address@hidden saved-face
address@hidden theme-face
+These properties are used to record a face's standard, saved,
+customized, and themed face specs.  Do not set them directly; they are
+managed by @code{defface} and related functions.  @xref{Defining
+Faces}.
+
address@hidden customized-value
address@hidden saved-value
address@hidden standard-value
address@hidden theme-value
+These properties are used to record a customizable variable's standard
+value, saved value, customized-but-unsaved value, and themed values.
+Do not set them directly; they are managed by @code{defcustom} and
+related functions.  @xref{Variable Definitions}.
+
address@hidden disabled
+If the value is address@hidden, the named function is disabled as a
+command.  @xref{Disabling Commands}.
+
address@hidden face-documentation
+The value stores the documentation string of the named face.  This is
+normally set automatically by @code{defface}.  @xref{Defining Faces}.
+
address@hidden history-length
+The value, if address@hidden, specifies the maximum minibuffer history
+length for the named history list variable.  @xref{Minibuffer
+History}.
+
address@hidden interactive-form
+The value is an interactive form for the named function.  Normally,
+you should not set this directly; use the @code{interactive} special
+form instead.  @xref{Interactive Call}.
+
address@hidden menu-enable
+The value is an expression for determining whether the named menu item
+should be enabled in menus.  @xref{Simple Menu Items}.
+
address@hidden mode-class
+If the value is @code{special}, the named major mode is ``special''.
address@hidden Mode Conventions}.
+
address@hidden permanent-local
+If the value is address@hidden, the named variable is a buffer-local
+variable whose value should not be reset when changing major modes.
address@hidden Buffer-Local}.
+
address@hidden permanent-local-hook
+If the value is address@hidden, the named function should not be
+deleted from the local value of a hook variable when changing major
+modes.  @xref{Setting Hooks}.
+
address@hidden pure
+This property is used internally to mark certain named functions for
+byte compiler optimization.  Do not set it.
+
address@hidden risky-local-variable
+If the value is address@hidden, the named variable is considered risky
+as a file-local variable.  @xref{File Local Variables}.
+
address@hidden safe-function
+If the value is address@hidden, the named function is considered
+generally safe for evaluation.  @xref{Function Safety}.
+
address@hidden safe-local-eval-function
+If the value is address@hidden, the named function is safe to call in
+file-local evaluation forms.  @xref{File Local Variables}.
+
address@hidden safe-local-variable
+The value specifies a function for determining safe file-local values
+for the named variable.  @xref{File Local Variables}.
+
address@hidden side-effect-free
+A address@hidden value indicates that the named function is free of
+side-effects, for determining function safety (@pxref{Function
+Safety}) as well as for byte compiler optimizations.  Do not set it.
+
address@hidden variable-documentation
+If address@hidden, this specifies the named vaariable's documentation
+string.  This is normally set automatically by @code{defvar} and
+related functions.  @xref{Defining Faces}.
address@hidden table

=== modified file 'doc/lispref/variables.texi'
--- a/doc/lispref/variables.texi        2012-11-12 08:23:23 +0000
+++ b/doc/lispref/variables.texi        2012-12-02 09:14:16 +0000
@@ -1423,7 +1423,6 @@
 subsequent major mode.  @xref{Hooks}.
 @end defvar
 
address@hidden Emacs 19 feature
 @cindex permanent local variable
 A buffer-local variable is @dfn{permanent} if the variable name (a
 symbol) has a @code{permanent-local} property that is address@hidden


reply via email to

[Prev in Thread] Current Thread [Next in Thread]