Mercurial > emacs
changeset 88083:178e852f7ddf
(file-remote-p): Docstring fix.
| author | Stefan Monnier <monnier@iro.umontreal.ca> |
|---|---|
| date | Wed, 30 Jan 2008 21:25:08 +0000 |
| parents | 439a3433552e |
| children | 60aaa6c4ca3c |
| files | lisp/files.el |
| diffstat | 1 files changed, 6 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/files.el Wed Jan 30 20:43:43 2008 +0000 +++ b/lisp/files.el Wed Jan 30 21:25:08 2008 +0000 @@ -765,12 +765,12 @@ (defun file-remote-p (file &optional identification connected) "Test whether FILE specifies a location on a remote system. -Return an identification of the system if the location is indeed -remote. The identification of the system may comprise a method -to access the system and its hostname, amongst other things. - -For example, the filename \"/user@host:/foo\" specifies a location -on the system \"/user@host:\". +Returns nil or a string identifying the remote connection (ideally +a prefix of FILE). For example, the remote identification for filename +\"/user@host:/foo\" could be \"/user@host:\". +A file is considered \"remote\" if accessing it is likely to be slower or +less reliable than accessing local files. +Furthermore, relative file names do not work across remote connections. IDENTIFICATION specifies which part of the identification shall be returned as string. IDENTIFICATION can be the symbol