changeset 105506:29b5ee370673

(Directory Names) <abbreviate-file-name>: Document that root home directories are not replaced with "~".
author Eli Zaretskii <eliz@gnu.org>
date Wed, 07 Oct 2009 10:19:21 +0000
parents 1ac34bb65afa
children c2d3ff52ae27
files doc/lispref/files.texi
diffstat 1 files changed, 7 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/files.texi	Wed Oct 07 09:58:54 2009 +0000
+++ b/doc/lispref/files.texi	Wed Oct 07 10:19:21 2009 +0000
@@ -1957,9 +1957,13 @@
 @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