From: Richard M. Stallman <rms@gnu.org>
Date: Mon, 9 Oct 1995 19:39:45 +0000 (+0000)
Subject: Explain when to use make-variable-buffer-local.
X-Git-Tag: emacs-19.34~2694
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ab4b18358fa636b07dd0fa88d54a2f8d89ef0079;p=emacs.git

Explain when to use make-variable-buffer-local.
---

diff --git a/lispref/variables.texi b/lispref/variables.texi
index c3bd61541d8..22813ea5b63 100644
--- a/lispref/variables.texi
+++ b/lispref/variables.texi
@@ -1213,6 +1213,15 @@ buffer-local, so that any subsequent attempt to set it will make it
 local to the current buffer at the time.
 
 The value returned is @var{variable}.
+
+@strong{Note:} It is a mistake to use @code{make-variable-buffer-local}
+for user-option variables, simply because users @emph{might} want to
+customize them differently in different buffers.  Users can make any
+variable local, when they wish to.
+
+The main use of @code{make-variable-buffer-local} is when a variable is
+used for internal purposes, and the Lisp program depends on having
+separate values in separate buffers.
 @end deffn
 
 @defun local-variable-p variable &optional buffer