From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=) Newsgroups: gmane.lisp.guile.devel Subject: Re: Documenting (system repl server) Date: Wed, 27 Mar 2013 22:10:33 +0100 Message-ID: <871ub0r1km.fsf@gnu.org> References: <87hak8r0qm.fsf@Kagami.home> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1364418665 18984 80.91.229.3 (27 Mar 2013 21:11:05 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 27 Mar 2013 21:11:05 +0000 (UTC) To: guile-devel@gnu.org Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Wed Mar 27 22:11:33 2013 Return-path: Envelope-to: guile-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UKxd3-0000w9-T0 for guile-devel@m.gmane.org; Wed, 27 Mar 2013 22:11:30 +0100 Original-Received: from localhost ([::1]:46881 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKxcf-0003RM-QU for guile-devel@m.gmane.org; Wed, 27 Mar 2013 17:11:05 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:39691) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKxcZ-0003QB-QH for guile-devel@gnu.org; Wed, 27 Mar 2013 17:11:01 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UKxcY-0000Vq-AG for guile-devel@gnu.org; Wed, 27 Mar 2013 17:10:59 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:52478) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKxcY-0000Vl-0S for guile-devel@gnu.org; Wed, 27 Mar 2013 17:10:58 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1UKxcs-0000Hd-Ak for guile-devel@gnu.org; Wed, 27 Mar 2013 22:11:18 +0100 Original-Received: from reverse-83.fdn.fr ([80.67.176.83]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 27 Mar 2013 22:11:18 +0100 Original-Received: from ludo by reverse-83.fdn.fr with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 27 Mar 2013 22:11:18 +0100 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 54 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: reverse-83.fdn.fr User-Agent: Gnus/5.130005 (Ma Gnus v0.5) Emacs/24.2 (gnu/linux) X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 7 Germinal an 221 de la =?utf-8?Q?R=C3=A9volution?= X-PGP-Key-ID: 0xEA52ECF4 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 83C4 F8E5 10A3 3B4C 5BEA D15D 77DD 95E2 EA52 ECF4 X-OS: x86_64-unknown-linux-gnu Cancel-Lock: sha1:u48nPwyC+gnXn0uiwbW0mpf7rmU= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:16034 Archived-At: Ian Price skribis: > For now, I have currently placed it in a new subsection of 6.17 (Reading > and Evaluating Scheme Code). I'm not entirely convinced this is the > right place for it, better suggestions welcome. Sounds good to me. > For 2, I have described the optional in the text, rather than trying to > placing the expression directly in the prototype. This has been discussed recently, but I think what you wrote it OK. > +@node REPL Servers > +@subsection REPL Servers > + > +The procedures in this section are provided by > +@lisp > +(use-modules (system repl server)) > +@end lisp > + > +When an application is written in Guile, it is often convenient to > +allow the user to be able to interact with it by evaluating Scheme > +expressions in a REPL. I would add something like “The procedures of this module allow you to spawn a @dfn{REPL server}, which permits interaction over a local or TCP connection.” Also, what about mentioning --listen, with a xref, as an example use? > +@deffn {Scheme Procedure} make-tcp-server-socket [#:host=#f] @ > + [#:addr] [#:port=37146] > +Returns a stream socket bound to a given address @var{addr} and port Should be “Return”. > +@deffn {Scheme Procedure} make-unix-domain-server-socket [#:path="/tmp/guile-socket"] > +Returns a UNIX domain socket, bound to a given @var{path}. Ditto. > +@deffn {Scheme Procedure} run-server [server-socket] > +@deffnx {Scheme Procedure} spawn-server [server-socket] > +@code{run-server} creates and runs a repl, making it available over Rather “Create and run a REPL” (“REPL” always uppercase). Also, two spaces after an end-of-sentence period (info "(texinfo) Not Ending a Sentence"). :-) Thanks for working on this! Ludo’.