* simple.el (start-file-process): Clarify docstring.
authorMichael Albinus <michael.albinus@gmx.de>
Fri, 9 May 2008 17:39:33 +0000 (17:39 +0000)
committerMichael Albinus <michael.albinus@gmx.de>
Fri, 9 May 2008 17:39:33 +0000 (17:39 +0000)
lisp/simple.el

index 7bb2972..885e2d5 100644 (file)
@@ -2436,9 +2436,14 @@ value passed."
 
 (defun start-file-process (name buffer program &rest program-args)
   "Start a program in a subprocess.  Return the process object for it.
+
 Similar to `start-process', but may invoke a file handler based on
-`default-directory'.  The current working directory of the
-subprocess is `default-directory'.
+`default-directory'.  See Info node `(elisp)Magic File Names'.
+
+This handler ought to run PROGRAM, perhaps on the local host,
+perhaps on a remote host that corresponds to `default-directory'.
+In the latter case, the local part of `default-directory' becomes
+the working directory of the process.
 
 PROGRAM and PROGRAM-ARGS might be file names.  They are not
 objects of file handler invocation."