[slime-devel] Documentation patch for swank:create-server

[Ury Marshak]

There seem to be some changes related to external-format that changed
the interface of swank:create-server. When looking for the source of the
breakage of my lisp startup I found that the description of 
swank:create-server
is missing from the manual. This is a small (documentation only) patch that
tries to fix this (using the new :coding-system syntax)

Cheers,
Ury

Index: ChangeLog
===================================================================
RCS file: /project/slime/cvsroot/slime/ChangeLog,v
retrieving revision 1.1002
diff -u -r1.1002 ChangeLog
--- ChangeLog	19 Nov 2006 21:25:15 -0000	1.1002
+++ ChangeLog	21 Nov 2006 14:59:31 -0000
@@ -5,6 +5,8 @@
 	(slime-coding): Deleted.
 
 	* swank.lisp (compile-file-for-emacs): Use guess-external-format.
+	(swank:create-server): no more accepts an  :external-format 'enc ,
+	use  :coding-system "enc"  instead.
 	
 	* swank-backend.lisp (find-external-format)
 	(guess-external-format): New.
Index: doc/slime.texi
===================================================================
RCS file: /project/slime/cvsroot/slime/doc/slime.texi,v
retrieving revision 1.48
diff -u -r1.48 slime.texi
--- doc/slime.texi	20 Sep 2006 18:37:47 -0000	1.48
+++ doc/slime.texi	21 Nov 2006 14:59:32 -0000
@@ -1460,10 +1460,8 @@
 
 inside a running lisp image at footnote{@SLIME{} also provides an
 @acronym{ASDF} system definiton which does the same thing}. Now all we
-need to do is startup our swank server. This example assumes we're
-using the default settings, if you need to do anything particular
-(like be able to reconnect to swank after you're done, look into
- at code{swank:create-server}'s other arguments).
+need to do is startup our swank server. The first example assumes we're
+using the default settings.
 
 @example
 (swank:create-server)
@@ -1480,6 +1478,37 @@
 (setf swank:*use-dedicated-output-stream* nil)
 @end example
 
+If you need to do anything particular
+(like be able to reconnect to swank after you're done), look into
+ at code{swank:create-server}'s other arguments. Some of these arguments
+are
+ at table @code
+
+ at item :PORT
+Port number for the server to listen on (default: 4005).
+ at item :STYLE
+See @xref{Communication style}.
+ at item :DONT-CLOSE
+Boolean indicating if the server will continue to accept connections
+after the first one (default: @code{NIL}). For ``long-running'' lisp processes
+to which you want to be able to connect from time to time,
+specify @code{:dont-close t}
+ at item :CODING-SYSTEM
+String designating the encoding to be used to communicate between the Emacs and Lisp.
+ at end table
+
+So the more complete example will be
+ at example
+(swank:create-server :port 4005  :dont-close t :coding-system "utf-8-unix")
+ at end example
+On the emacs side you will use something like
+ at example
+(setq slime-net-coding-system 'utf-8-unix)
+(slime-connect "127.0.0.1" 4005))
+ at end example
+to connect to this lisp image from the same machine.
+
+
 @node Setting up Emacs
 @subsection Setting up Emacs