1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-21 18:23:59 +00:00

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)
This commit is contained in:
Eli Zaretskii 2018-06-23 10:50:58 +03:00
parent decdfedf02
commit 8182d648cb

View File

@ -599,7 +599,10 @@ running, ask the user for confirmation first, unless optional
argument INHIBIT-PROMPT is non-nil. argument INHIBIT-PROMPT is non-nil.
To force-start a server, do \\[server-force-delete] and then 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") (interactive "P")
(when (or (not server-clients) (when (or (not server-clients)
;; Ask the user before deleting existing clients---except ;; Ask the user before deleting existing clients---except
@ -725,7 +728,11 @@ Return values:
nil the server is definitely not running. nil the server is definitely not running.
t the server seems to be running. t the server seems to be running.
something else we cannot determine whether it's running without using 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)) (unless name (setq name server-name))
(condition-case nil (condition-case nil
(if server-use-tcp (if server-use-tcp