summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>1997-04-11 18:31:38 +0000
committerRichard M. Stallman <rms@gnu.org>1997-04-11 18:31:38 +0000
commitde96e053b276b1e0fc809237926da1302e25623d (patch)
treeb9161d0669010afe047a018964bb83585dbeb54e /lispref
parent4beabe51489c6676a4ff4930c5841a4988c76a36 (diff)
downloademacs-de96e053b276b1e0fc809237926da1302e25623d.tar.gz
(file-relative-name): Say correctly when the value is absolute.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/files.texi9
1 files changed, 7 insertions, 2 deletions
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/")