diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2018-06-23 10:50:58 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-06-23 10:50:58 +0300 |
| commit | 8182d648cb18fb048495c761db7c21fbf3c2a624 (patch) | |
| tree | 92b76aa2b7f60c9f98c7bcd7801b5559e45ffe92 /lisp | |
| parent | decdfedf029904c3ecaa082e59e2501572ec77c9 (diff) | |
| download | emacs-8182d648cb18fb048495c761db7c21fbf3c2a624.tar.gz | |
Improve documentation of 'server-start' and friends
* lisp/server.el (server-start, server-running-p): Document how to
reliably check that the current Emacs process started the server.
(Bug#31859)
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/server.el | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/lisp/server.el b/lisp/server.el index ac0d7018513..270eff55dcd 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -599,7 +599,10 @@ running, ask the user for confirmation first, unless optional argument INHIBIT-PROMPT is non-nil. To force-start a server, do \\[server-force-delete] and then -\\[server-start]." +\\[server-start]. + +To check from a Lisp program whether a server is running, use +the `server-process' variable." (interactive "P") (when (or (not server-clients) ;; Ask the user before deleting existing clients---except @@ -725,7 +728,11 @@ Return values: nil the server is definitely not running. t the server seems to be running. something else we cannot determine whether it's running without using - commands which may have to wait for a long time." + commands which may have to wait for a long time. + +This function can return non-nil if the server was started by some other +Emacs process. To check from a Lisp program whether a server was started +by the current Emacs process, use the `server-process' variable." (unless name (setq name server-name)) (condition-case nil (if server-use-tcp |