From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: ludovic.courtes@laas.fr (Ludovic =?iso-8859-1?Q?Court=E8s?=) Newsgroups: gmane.lisp.guile.devel Subject: Re: Socket API improvement, patch #6 Date: Wed, 02 Nov 2005 11:50:06 +0100 Organization: LAAS-CNRS Message-ID: <8764rbz5lt.fsf@laas.fr> References: <87oecutxox.fsf@laas.fr> <87vf58cxxq.fsf@zagadka.de> <87k6kwopv5.fsf@laas.fr> <87fysk7ady.fsf@zagadka.de> <87mzmpmcm2.fsf@laas.fr> <87aci6u6f4.fsf@laas.fr> <87psr22c2p.fsf@zip.com.au> <87irwtqkop.fsf@laas.fr> <87slvog9sd.fsf@zip.com.au> <87wtkt9xyq.fsf_-_@laas.fr> <87hdbg4dl7.fsf@laas.fr> <87br1nakge.fsf@zip.com.au> <87hdbfnu9n.fsf@laas.fr> <87d5m2twaf.fsf@uni-dortmund.de> <878xwjb123.fsf@laas.fr> <874q76h9rh.fsf@zip.com.au> <87hdb5qogp.fsf@zagadka.de> <87zmovn4y5.fsf@zip.com.au> <87fyqn1gzy.fsf@laas.fr> <87br196yd8.fsf@zip.com.au> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1130930328 10379 80.91.229.2 (2 Nov 2005 11:18:48 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 2 Nov 2005 11:18:48 +0000 (UTC) Cc: guile-devel@gnu.org Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Wed Nov 02 12:18:47 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1EXGd3-0001GK-H9 for guile-devel@m.gmane.org; Wed, 02 Nov 2005 12:18:05 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EXGd2-0008Jz-Lv for guile-devel@m.gmane.org; Wed, 02 Nov 2005 06:18:04 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1EXGC7-0005WN-7e for guile-devel@gnu.org; Wed, 02 Nov 2005 05:50:15 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1EXGC5-0005Vk-H6 for guile-devel@gnu.org; Wed, 02 Nov 2005 05:50:14 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1EXGC5-0005Vg-1c for guile-devel@gnu.org; Wed, 02 Nov 2005 05:50:13 -0500 Original-Received: from [140.93.0.15] (helo=laas.laas.fr) by monty-python.gnu.org with esmtp (TLS-1.0:DHE_RSA_3DES_EDE_CBC_SHA:24) (Exim 4.34) id 1EXGC5-0006Av-2t for guile-devel@gnu.org; Wed, 02 Nov 2005 05:50:13 -0500 Original-Received: by laas.laas.fr (8.13.1/8.13.4) with SMTP id jA2Ao6NC004123; Wed, 2 Nov 2005 11:50:11 +0100 (CET) Original-To: Kevin Ryde X-URL: http://www.laas.fr/~lcourtes/ X-Revolutionary-Date: 12 Brumaire an 214 de la =?iso-8859-1?Q?R=E9volution?= X-PGP-Key-ID: 0xEB1F5364 X-PGP-Key: http://www.laas.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 821D 815D 902A 7EAB 5CEE D120 7FBA 3D4F EB1F 5364 X-OS: powerpc-unknown-linux-gnu Mail-Followup-To: Kevin Ryde , guile-devel@gnu.org In-Reply-To: <87br196yd8.fsf@zip.com.au> (Kevin Ryde's message of "Sat, 29 Oct 2005 09:00:19 +1000") User-Agent: Gnus/5.110004 (No Gnus v0.4) Emacs/21.4 (gnu/linux) X-Spam-Score: 0.496 () MAILTO_TO_SPAM_ADDR X-Scanned-By: MIMEDefang at CNRS-LAAS X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:5371 Archived-At: Hi, Kevin Ryde writes: > Beaut, I gave it a bit of a tweak and applied it. Ok, I'm nitpicking: basically, for function descriptions, I prefer the style that I used rather than your style. For instance, I suggested: @deftypefn {C Function} {struct sockaddr *}scm_c_make_socket_address (SCM family, SCM address, SCM args, size_t *address_size) Return a newly-allocated @code{sockaddr} structure that reflects @var{address}, an address of family @var{family}, with the family-specific parameters @var{args} (see the description of @var{make-socket-address} for details). On success, a non-@code{NULL} pointer is returned and @var{address_size} is updated to the actual size (in bytes) of the returned address. The returned structure must eventually be freed using @code{free ()}. @end deftypefn while you preferred: @deftypefn {C Function} {struct sockaddr *} scm_c_make_socket_address (SCM family, SCM address, SCM args, size_t *outsize) Return a newly-@code{malloc}ed @code{struct sockaddr} created from arguments like those taken by @code{scm_make_socket_address} above. The size (in bytes) of the @code{struct sockaddr} return is stored into @code{*@var{outsize}}. An application must call @code{free} to release the returned structure when no longer required. @end deftypefn IMO, the style you used is "sploppier" and less concise. The "formal" declarative style I used is also more consistent with the rest of the manual and other GNU manuals as well I think. Ludovic. _______________________________________________ Guile-devel mailing list Guile-devel@gnu.org http://lists.gnu.org/mailman/listinfo/guile-devel