From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Bake Timmons Newsgroups: gmane.lisp.guile.bugs Subject: [bug #31969] omission in docs of scm_misc_error() Date: Sat, 25 Dec 2010 06:02:54 +0000 Message-ID: <20101225-060254.sv66629.61618@savannah.gnu.org> References: <20101225-054437.sv0.56685@savannah.gnu.org> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain;charset=UTF-8 X-Trace: dough.gmane.org 1293256971 18735 80.91.229.12 (25 Dec 2010 06:02:51 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Sat, 25 Dec 2010 06:02:51 +0000 (UTC) To: Bake Timmons , bug-guile@gnu.org Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Sat Dec 25 07:02:47 2010 Return-path: Envelope-to: guile-bugs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1PWNDK-00035L-Rx for guile-bugs@m.gmane.org; Sat, 25 Dec 2010 07:02:47 +0100 Original-Received: from localhost ([127.0.0.1]:49978 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PWNDK-0005VQ-4V for guile-bugs@m.gmane.org; Sat, 25 Dec 2010 01:02:46 -0500 Original-Received: from [140.186.70.92] (port=37256 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PWNDC-0005VI-Nf for bug-guile@gnu.org; Sat, 25 Dec 2010 01:02:39 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PWNDB-00061E-NZ for bug-guile@gnu.org; Sat, 25 Dec 2010 01:02:38 -0500 Original-Received: from colonialone.fsf.org ([140.186.70.51]:49196 helo=internal.in.savannah.gnu.org) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PWNDB-000615-I7 for bug-guile@gnu.org; Sat, 25 Dec 2010 01:02:37 -0500 Original-Received: from [10.1.0.103] (helo=frontend.in.savannah.gnu.org) by internal.in.savannah.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1PWNDT-0007vk-2t; Sat, 25 Dec 2010 06:02:55 +0000 Original-Received: from www-data by frontend.in.savannah.gnu.org with local (Exim 4.69) (envelope-from ) id 1PWNDS-00035l-VO; Sat, 25 Dec 2010 06:02:54 +0000 X-Savane-Server: savannah.gnu.org:443 [10.1.0.103] X-Savane-Project: guile X-Savane-Tracker: bugs X-Savane-Item-ID: 31969 User-Agent: w3m/0.5.2 X-Apparently-From: 192.94.73.16 (Savane authenticated user bt3) In-Reply-To: <20101225-054437.sv0.56685@savannah.gnu.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-BeenThere: bug-guile@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:4941 Archived-At: Follow-up Comment #1, bug #31969 (project guile): The following patch is what I intended to attach to the initial bug report: diff --git a/guile.orig/doc/ref/api-control.texi b/guile/doc/ref/api-control.texi index c8c93ba..08a8783 100644 --- a/guile.orig/doc/ref/api-control.texi +++ b/guile/doc/ref/api-control.texi @@ -1493,13 +1493,21 @@ and the call to these routines doesn't change @code{errno}. @deftypefnx {C Function} void scm_wrong_type_arg_msg (char *@var{subr}, int @var{argnum}, SCM @var{bad_value}, const char *@var{expected}) @deftypefnx {C Function} void scm_memory_error (char *@var{subr}) Throw an error with the various keys described above. +@deftypefnx {C Function} void scm_misc_error (const char *@var{subr}, const char *@var{message}, SCM @var{args}) -For @code{scm_wrong_num_args}, @var{proc} should be a Scheme symbol +In @code{scm_wrong_num_args}, @var{proc} should be a Scheme symbol which is the name of the procedure incorrectly invoked. The other routines take the name of the invoked procedure as a C string. In @code{scm_wrong_type_arg_msg}, @var{expected} is a C string describing the type of argument that was expected. + +In @code{scm_misc_error}, @var{message} is the error message string, +possibly containing @code{~S} and @code{~A} escapes. When an error is +reported, these are replaced by formatting the corresponding members of +@var{args}: @code{~A} (was @code{%s} in older versions of Guile) formats +using @code{display} and @code{~S} (was @code{%S}) formats using +@code{write}. @end deftypefn _______________________________________________________ Reply to this item at: _______________________________________________ Message sent via/by Savannah http://savannah.gnu.org/