[Emacs-diffs] /srv/bzr/emacs/trunk r107060: server.el doc fixes

[Glenn Morris]

------------------------------------------------------------
revno: 107060
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Wed 2012-02-01 23:48:39 -0800
message:
  server.el doc fixes
  
  * lisp/server.el (server-auth-dir): Doc fix.
  (server-eval-at): Doc fix.  Give an explicit error if !server-use-tcp.
  
  * etc/NEWS: Markup.
modified:
  etc/NEWS
  lisp/ChangeLog
  lisp/server.el

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2012-02-02 07:21:20 +0000
+++ b/etc/NEWS  2012-02-02 07:48:39 +0000
@@ -1237,8 +1237,9 @@
 *** New macro `with-wrapper-hook' for running an abnormal hook as a
 set of "wrapping" filters, similar to around advice.
 
-** `server-eval-at' is provided to allow evaluating forms on different
-Emacs server instances.
++++
+** The new function `server-eval-at' allows evaluation of Lisp forms on
+named Emacs server instances, using TCP sockets.
 
 +++
 ** `call-process' and `call-process-region' allow a `(:file "file")' spec

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-02-02 02:57:26 +0000
+++ b/lisp/ChangeLog    2012-02-02 07:48:39 +0000
@@ -1,5 +1,8 @@
 2012-02-02  Glenn Morris  <address@hidden>
 
+       * server.el (server-auth-dir): Doc fix.
+       (server-eval-at): Doc fix.  Give an explicit error if !server-use-tcp.
+
        * subr.el (run-mode-hooks): Doc fix.
 
 2012-02-02  Juri Linkov  <address@hidden>

=== modified file 'lisp/server.el'
--- a/lisp/server.el    2012-01-19 07:21:25 +0000
+++ b/lisp/server.el    2012-02-02 07:48:39 +0000
@@ -126,6 +126,8 @@
 
 (defcustom server-auth-dir (locate-user-emacs-file "server/")
   "Directory for server authentication files.
+We only use this if `server-use-tcp' is non-nil.
+Otherwise we use `server-socket-dir'.
 
 NOTE: On FAT32 filesystems, directories are not secure;
 files can be read and modified by any user or process.
@@ -1525,7 +1527,14 @@
   nil)
 
 (defun server-eval-at (server form)
-  "Eval FORM on Emacs Server SERVER."
+  "Contact the Emacs server named SERVER and evaluate FORM there.
+Returns the result of the evaluation, or signals an error if it
+cannot contact the specified server.  For example:
+  \(server-eval-at \"server\" '(emacs-pid))
+returns the process ID of the Emacs instance running \"server\".
+This function requires the use of TCP sockets. "
+  (or server-use-tcp
+      (error "This function requires TCP sockets"))
   (let ((auth-file (expand-file-name server server-auth-dir))
        (coding-system-for-read 'binary)
        (coding-system-for-write 'binary)