procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of a recent change

Browse source 
* doc/lispref/processes.texi (Subprocess Creation): Improve
wording of documentation for the function 'exec-path'.

* etc/NEWS: Improve wording and formatting of recently added
entries.

* lisp/files.el (exec-path): Doc fix.
This commit is contained in:
Eli Zaretskii 2018-06-20 18:39:41 +03:00
parent 6f649e77b8
commit dffe02d259
3 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/lispref/processes.texi
View file

@ -178,9 +178,9 @@ independently of @env{PATH} can lead to confusing results.
@end defopt
@defun exec-path
The function @code{exec-path} is an extension of the respective
variable. If @code{default-directory} indicates a remote directory,
it returns a list of directories used for searching programs on the
This function is an extension of the variable @code{exec-path}. If
@code{default-directory} indicates a remote directory, this function
returns a list of directories used for searching programs on the
respective remote host. In case of a local @code{default-directory},
the function returns just the value of the variable @code{exec-path}.
@end defun

9
etc/NEWS
View file

@ -146,11 +146,14 @@ regular expression was previously invalid, but is now accepted:
** The German prefix and postfix input methods now support Capital sharp S.
+++
** The new function 'exec-path' returns a directory list from a remote host.
** New function 'exec-path'.
This function by default returns the value of the corresponding
variable, but can optionally return the equivalent of 'exec-path'
from a remote host.
+++
** Function 'executable-find' supports an optional argument REMOTE.
This triggers to search a program name on the remote host indicated by
** The function 'executable-find' supports an optional argument REMOTE.
This triggers to search the program on the remote host as indicated by
'default-directory'.

6
lisp/files.el
View file

@ -1025,11 +1025,11 @@ customize the variable `user-emacs-directory-warning'."
bestname))))
(defun exec-path ()
"List of directories to search programs to run in remote subprocesses.
"Return list of directories to search programs to run in remote subprocesses.
The remote host is identified by `default-directory'. For remote
hosts which do not support subprocesses, this returns `nil'.
If `default-directory' is a local directory, the value of the variable
`exec-path' is returned."
If `default-directory' is a local directory, this function retruns
the value of the variable `exec-path'."
(let ((handler (find-file-name-handler default-directory 'exec-path)))
(if handler
(funcall handler 'exec-path)