From: Richard M. Stallman <rms@gnu.org>
Date: Fri, 11 Apr 1997 18:31:38 +0000 (+0000)
Subject: (file-relative-name): Say correctly when the value is absolute.
X-Git-Tag: emacs-20.1~2547
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=89c771728bc03623d78312c9d8035218f6a657d5;p=emacs.git

(file-relative-name): Say correctly when the value is absolute.
---

diff --git a/lispref/files.texi b/lispref/files.texi
index db196c8f7ee..950eea2c2af 100644
--- a/lispref/files.texi
+++ b/lispref/files.texi
@@ -1561,8 +1561,13 @@ variables; only @code{substitute-in-file-name} does that.
 @defun file-relative-name filename directory
 This function does the inverse of expansion---it tries to return a
 relative name that is equivalent to @var{filename} when interpreted
-relative to @var{directory}.  (If such a relative name would be longer
-than the absolute name, it returns the absolute name instead.)
+relative to @var{directory}.
+
+On some operating systems, an absolute file name begins with a device
+name.  On such systems, @var{filename} has no relative equivalent based
+on @var{directory} if they start with two different device names.  In
+this case, @code{file-relative-name} returns @var{filename} in absolute
+form.
 
 @example
 (file-relative-name "/foo/bar" "/foo/")