changeset 103102:789636652cc9

* variables.texi (File Local Variables): Note that read-circle is bound to nil when reading file-local variables. * streams.texi (Input Functions): Document read-circle. (Output Variables): Add xref to Circular Objects.
author Chong Yidong <cyd@stupidchicken.com>
date Wed, 29 Apr 2009 03:13:16 +0000
parents 58c92ec0c915
children 4a7a1526ee6d
files doc/lispref/ChangeLog doc/lispref/streams.texi doc/lispref/variables.texi
diffstat 3 files changed, 21 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/ChangeLog	Wed Apr 29 03:02:54 2009 +0000
+++ b/doc/lispref/ChangeLog	Wed Apr 29 03:13:16 2009 +0000
@@ -1,3 +1,11 @@
+2009-04-29  Chong Yidong  <cyd@stupidchicken.com>
+
+	* variables.texi (File Local Variables): Note that read-circle is
+	bound to nil when reading file-local variables.
+
+	* streams.texi (Input Functions): Document read-circle.
+	(Output Variables): Add xref to Circular Objects.
+
 2009-04-25  Chong Yidong  <cyd@stupidchicken.com>
 
 	* tips.texi (Coding Conventions): Copyedits.  Add xref to Named
--- a/doc/lispref/streams.texi	Wed Apr 29 03:02:54 2009 +0000
+++ b/doc/lispref/streams.texi	Wed Apr 29 03:13:16 2009 +0000
@@ -341,6 +341,12 @@
 The default is @code{t}, meaning use the minibuffer.
 @end defvar
 
+@defvar read-circle
+If non-@code{nil}, this variable enables the reading of circular and
+shared structures.  @xref{Circular Objects}.  Its default value is
+@code{t}.
+@end defvar
+
 @node Output Streams
 @section Output Streams
 @cindex stream (for printing)
@@ -794,8 +800,8 @@
 and shared structure:
 
 @defvar print-circle
-If non-@code{nil}, this variable enables detection of circular
-and shared structure in printing.
+If non-@code{nil}, this variable enables detection of circular and
+shared structure in printing.  @xref{Circular Objects}
 @end defvar
 
 @defvar print-gensym
--- a/doc/lispref/variables.texi	Wed Apr 29 03:02:54 2009 +0000
+++ b/doc/lispref/variables.texi	Wed Apr 29 03:13:16 2009 +0000
@@ -1539,6 +1539,11 @@
 those file-local variables whose specified values are known to be
 safe.  Other file-local variables are set only if the user agrees.
 
+  For additional safety, @code{read-circle} is temporarily bound to
+@code{nil} when Emacs reads file-local variables (@pxref{Input
+Functions}).  This prevents the Lisp reader from recognizing circular
+and shared Lisp structures (@pxref{Circular Objects}).
+
 @defopt enable-local-variables
 This variable controls whether to process file-local variables.
 The possible values are: