From: Glenn Morris <rgm@gnu.org>
Date: Tue, 6 Mar 2012 02:31:32 +0000 (-0500)
Subject: * lisp/files.el (locate-dominating-file): Doc fix.
X-Git-Url: https://git.hcoop.net/bpt/emacs.git/commitdiff_plain/eb18244605c440f79caf2d46edad2734a438dbb7

* lisp/files.el (locate-dominating-file): Doc fix.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 7bf2ba1bcc..76166b50c0 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2012-03-06  Glenn Morris  <rgm@gnu.org>
+
+	* files.el (locate-dominating-file): Doc fix.
+
 2012-03-06  Adam Spiers  <emacs@adamspiers.org>  (tiny change)
 
 	* calendar/calendar.el (calendar-set-mode-line):
diff --git a/lisp/files.el b/lisp/files.el
index 88ebb9eaab..d9a3e4b0f7 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -880,7 +880,10 @@ or mount points potentially requiring authentication as a different user.")
 (defun locate-dominating-file (file name)
   "Look up the directory hierarchy from FILE for a file named NAME.
 Stop at the first parent directory containing a file NAME,
-and return the directory.  Return nil if not found."
+and return the directory.  Return nil if not found.
+
+This function only tests if FILE exists.  If you care about whether
+it is readable, regular, etc., you should test the result."
   ;; We used to use the above locate-dominating-files code, but the
   ;; directory-files call is very costly, so we're much better off doing
   ;; multiple calls using the code in here.