Re: Uncomprehensible DOC string

[Michael Albinus <michael.albinus@gmx.de>]

David Kastrup <dak@gnu.org> writes:

>> _The_ file name handler, which belongs to `default-directory', will be
>> applied.
>
> To what will it be applied?

???

To the arguments auf `start-file-process', of course. Like every other
file name handler. That's why the doc strings says "Similar to
`start-process'".

>> Currently, there ought to be only one implementation of such a file
>> name handler, `tramp-handle-start-file-process'. _This_ file name
>> handler runs the command on the corresponding remote host.
>
> So what the file name handler will be employed for is executing the
> program on potentially remote host.  This information is _absent_ from
> the DOC string, and it shouldn't.  In contrast, what a file name handler
> _is_, is best left to the info documentation.

I will add a sentence that, when `default-directory' points to a
remote host, the command will run on that remote host. But this is
just an implementation note for Tramp; there could be other file name
handler implementations for `start-file-process' as well. Admittedly,
Tramp's implementation is the only one today.

Best regards, Michael.