From: Glenn Morris <rgm@gnu.org>
Date: Fri, 25 Feb 2011 07:59:40 +0000 (-0800)
Subject: Doc fix for bug#3577.
X-Git-Tag: emacs-23.3~6
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=081f76404c8c798c4e2d4d30d5a7d6fa2399a3da;p=emacs.git

Doc fix for bug#3577.

* doc/lispref/variables.texi (Directory Local Variables):
Mention the optional mtime argument of dir-locals-set-directory-class.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 9be1104a256..2bb357cf8a1 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2011-02-25  Glenn Morris  <rgm@gnu.org>
+
+	* variables.texi (Directory Local Variables): Mention the optional
+	mtime argument of dir-locals-set-directory-class.  (Bug#3577)
+
 2011-02-18  Eli Zaretskii  <eliz@gnu.org>
 
 	* elisp.texi: Sync @dircategory with ../../info/dir.
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi
index 18343b4dc85..1c86a7eb65c 100644
--- a/doc/lispref/variables.texi
+++ b/doc/lispref/variables.texi
@@ -1759,12 +1759,19 @@ recursively by following the above rules; @var{list} should be of one
 of the two forms accepted by this function in @var{variables}.
 @end defun
 
-@defun dir-locals-set-directory-class directory class
+@defun dir-locals-set-directory-class directory class &optional mtime
 This function assigns @var{class} to all the files in @code{directory}
 and its subdirectories.  Thereafter, all the variable settings
 specified for @var{class} will be applied to any visited file in
 @var{directory} and its children.  @var{class} must have been already
-defined by @code{dir-locals-set-class-variables}
+defined by @code{dir-locals-set-class-variables}.
+
+Emacs uses this function internally when it loads directory variables
+from a @code{.dir-locals.el} file.  In that case, the optional
+argument @var{mtime} holds the file modification time (as returned by
+@code{file-attributes}).  Emacs uses this time to check stored
+local variables are still valid.  If you are assigning a class
+directly, not via a file, this argument should be @code{nil}.
 @end defun
 
 @defvar dir-locals-class-alist
@@ -1774,8 +1781,9 @@ settings.  It is updated by @code{dir-locals-set-class-variables}.
 
 @defvar dir-locals-directory-cache
 This alist holds directory names, their assigned class names, and
-modification times of the associated directory local variables file.
-It is updated by @code{dir-locals-set-directory-class}.
+modification times of the associated directory local variables file
+(if there is one).  The function @code{dir-locals-set-directory-class}
+updates this list.
 @end defvar
 
 @node Frame-Local Variables