changeset 94808:8b60ad9b42c3

* simple.el (start-file-process): Clarify docstring.
author Michael Albinus <michael.albinus@gmx.de>
date Fri, 09 May 2008 17:39:33 +0000
parents d58ec1c0d828
children 76b523d99056
files lisp/simple.el
diffstat 1 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/simple.el	Fri May 09 17:38:44 2008 +0000
+++ b/lisp/simple.el	Fri May 09 17:39:33 2008 +0000
@@ -2436,9 +2436,14 @@
 
 (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."