From: Kai Großjohann <kgrossjo@eu.uu.net>
Date: Fri, 2 Jul 2004 14:49:39 +0000 (+0000)
Subject: (Magic File Names): `file-remote-p' returns an identifier of the
X-Git-Tag: ttn-vms-21-2-B4~5567
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8addb6ebbaecbad78010d66475d6ae5418cb0416;p=emacs.git

(Magic File Names): `file-remote-p' returns an identifier of the
remote system, not just t.
---

diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index ff73949f771..d2bddd9d1b4 100644
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2004-07-02  Kai Grossjohann  <kai@emptydomain.de>
+
+	* files.texi (Magic File Names): `file-remote-p' returns an
+	identifier of the remote system, not just t.
+
 2004-07-02  David Kastrup  <dak@gnu.org>
 
 	* searching.texi (Entire Match Data): Add explanation about new
diff --git a/lispref/files.texi b/lispref/files.texi
index 10d6c808625..3fb9460da8a 100644
--- a/lispref/files.texi
+++ b/lispref/files.texi
@@ -2646,7 +2646,23 @@ of the local copy file.
 @end defun
 
 @defun file-remote-p filename
-This function returns @code{t} if @var{filename} is a remote file.
+This function tests whether @var{filename} is a remote file.  The
+return value is an identifier of the remote system, if @var{filename}
+is indeed remote.  Besides the host name, the identifier may comprise
+a user name and a method used to access that system.
+
+To illustrate, for the filename @code{/ssh:user@@host:/some/file}, the
+identifier is @code{/ssh:user@@host:}.
+
+If @var{filename} is local (not remote), then the return value is
+@code{nil}.
+
+If @code{file-remote-p} returns the same identifier for two different
+filenames, then the file handler is the same, and also the files can
+be accessed locally with respect to each other.  This means, for
+example, that it is possible to start a (remote) process accessing
+both files at the same time.  Implementors of file handlers need to
+ensure this.
 @end defun
 
 @defun unhandled-file-name-directory filename