changeset 98782:05eaa923b9eb

(Fexpand_file_name): Doc fix.
author Chong Yidong <cyd@stupidchicken.com>
date Thu, 16 Oct 2008 17:59:34 +0000
parents 33743665b315
children 9ae4dbce33ae
files src/fileio.c
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/fileio.c	Thu Oct 16 17:59:24 2008 +0000
+++ b/src/fileio.c	Thu Oct 16 17:59:34 2008 +0000
@@ -819,7 +819,13 @@
 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;
 {