From 2e8825d6c55409c15749b12dacc1f49f9c8783c7 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 29 Dec 2018 17:34:57 +0200 Subject: Improve documentation of 'file-local-name' and related APIs * doc/lispref/files.texi (Unique File Names) (Magic File Names, File Name Expansion): Improve documentation of the "local part" of a remote file name. * doc/lispref/processes.texi (Synchronous Processes) (Asynchronous Processes): State explicitly that program and file names passed to functions that start remote processes need to be relative or obtained by 'file-local-name'. * lisp/files.el (file-local-name): * lisp/simple.el (start-file-process, process-file): Improve the documentation of the "local part" of a remote file name, and its use in APIs that start remote processes. --- lisp/files.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'lisp/files.el') diff --git a/lisp/files.el b/lisp/files.el index 7794f398cf9..e9d40f22f1c 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -1150,7 +1150,10 @@ consecutive checks. For example: (defun file-local-name (file) "Return the local name component of FILE. -It returns a file name which can be used directly as argument of +This function removes from FILE the specification of the remote host +and the method of accessing the host, leaving only the part that +identifies FILE locally on the remote system. +The returned file name can be used directly as argument of `process-file', `start-file-process', or `shell-command'." (or (file-remote-p file 'localname) file)) -- cgit v1.2.3