[Emacs-diffs] /srv/bzr/emacs/trunk r107513: * lisp/files.el (locate-dominating-file): Doc fix.

[Glenn Morris]

------------------------------------------------------------
revno: 107513
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Mon 2012-03-05 21:31:32 -0500
message:
  * lisp/files.el (locate-dominating-file): Doc fix.
modified:
  lisp/ChangeLog
  lisp/files.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-03-06 02:18:29 +0000
+++ b/lisp/ChangeLog    2012-03-06 02:31:32 +0000
@@ -1,3 +1,7 @@
+2012-03-06  Glenn Morris  <address@hidden>
+
+       * files.el (locate-dominating-file): Doc fix.
+
 2012-03-06  Adam Spiers  <address@hidden>  (tiny change)
 
        * calendar/calendar.el (calendar-set-mode-line):

=== modified file 'lisp/files.el'
--- a/lisp/files.el     2012-03-01 08:33:50 +0000
+++ b/lisp/files.el     2012-03-06 02:31:32 +0000
@@ -880,7 +880,10 @@
 (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.