(Fexpand_file_name): Doc fix.
authorChong Yidong <cyd@stupidchicken.com>
Thu, 16 Oct 2008 17:59:34 +0000 (17:59 +0000)
committerChong Yidong <cyd@stupidchicken.com>
Thu, 16 Oct 2008 17:59:34 +0000 (17:59 +0000)
src/fileio.c

index cf3ec5b..0208b9c 100644 (file)
@@ -819,7 +819,13 @@ note that these simplifications are done without checking the resulting
 file names in the file system.
 An initial `~/' expands to your home directory.
 An initial `~USER/' expands to USER's home directory.
-See also the function `substitute-in-file-name'.  */)
+See also the function `substitute-in-file-name'.
+
+For technical reasons, this function can return correct but
+non-intuitive results for the root directory; for instance,
+\(expand-file-name ".." "/") returns "/..".  For this reason, use
+(directory-file-name (file-name-directory dirname)) to traverse a
+filesystem tree, not (expand-file-name ".."  dirname).  */)
      (name, default_directory)
      Lisp_Object name, default_directory;
 {