changeset 52143:3b706f94b559

(Magic File Names): Add file-remote-p. Clarify file-local-copy.
author Richard M. Stallman <rms@gnu.org>
date Wed, 06 Aug 2003 01:28:35 +0000
parents 187f0047b980
children 85f4da4e24de
files lispref/files.texi
diffstat 1 files changed, 16 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/files.texi	Wed Aug 06 01:25:23 2003 +0000
+++ b/lispref/files.texi	Wed Aug 06 01:28:35 2003 +0000
@@ -2461,15 +2461,22 @@
 @end defun
 
 @defun file-local-copy filename
-This function copies file @var{filename} to an ordinary non-magic file,
-if it isn't one already.
-
-If @var{filename} specifies a magic file name, which programs
-outside Emacs cannot directly read or write, this copies the contents to
-an ordinary file and returns that file's name.
-
-If @var{filename} is an ordinary file name, not magic, then this function
-does nothing and returns @code{nil}.
+This function copies file @var{filename} to an ordinary non-magic file
+on the local machine, if it isn't on the local machine already.  Magic
+file names should handle the @code{file-local-copy} operation if they
+refer to files on other machines.  A magic file name that is used for
+other purposes than remote file access should not handle
+@code{file-local-copy}; then this function will treat the file as
+local.
+
+If @var{filename} is local, whether magic or not, this function does
+nothing and returns @code{nil}.  Otherwise it returns the file name
+of the local copy file.
+@end defun
+
+@defun file-remote-p filename
+This functions return @code{t} if @var{filename} is a remote file---that is,
+a magic file name that handles @code{file-local-copy}.
 @end defun
 
 @defun unhandled-file-name-directory filename