(Directory Names) <abbreviate-file-name>: Document that root home

directories are not replaced with "~".

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 1e4c99aece291209eaffc69aaa7ae96fc045e35a..4edc4230664315ba9f565aabef298ab6faec6c2f 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2009-10-07  Eli Zaretskii  <eliz@gnu.org>
+
+       * files.texi (Directory Names) <abbreviate-file-name>: Document
+       that root home directories are not replaced with "~".
+
 2009-10-06  Eli Zaretskii  <eliz@gnu.org>
 
        * text.texi (Special Properties): Document the meaning of the

diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index 46ce7c4e6e2b2790d742c61011248f62cc0c6b6c..8f47dfadd6c15b8e87a0c7cf3366ceaf755fbfc8 100644 (file)
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1957,9 +1957,13 @@ function:
 @defun abbreviate-file-name filename
 @anchor{Definition of abbreviate-file-name}
 This function applies abbreviations from @code{directory-abbrev-alist}
-to its argument, and substitutes @samp{~} for the user's home
-directory.  You can use it for directory names and for file names,
-because it recognizes abbreviations even as part of the name.
+to its argument, and also substitutes @samp{~} for the user's home
+directory if the argument names a file in the home directory or one of
+its subdirectories.  (If the home directory is a root directory, it is
+not replaced with @samp{~}, because this does not make the result
+shorter on many systems.)  You can use it for directory names and for
+file names, because it recognizes abbreviations even as part of the
+name.
 @end defun
 
 @node File Name Expansion