From: Bake Timmons <INVALID.NOREPLY@gnu.org>
To: Bake Timmons <b3timmons@speedymail.org>, bug-guile@gnu.org
Subject: [bug #31969] omission in docs of scm_misc_error()
Date: Sat, 25 Dec 2010 06:02:54 +0000 [thread overview]
Message-ID: <20101225-060254.sv66629.61618@savannah.gnu.org> (raw)
In-Reply-To: <20101225-054437.sv0.56685@savannah.gnu.org>
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:
<http://savannah.gnu.org/bugs/?31969>
_______________________________________________
Message sent via/by Savannah
http://savannah.gnu.org/
next prev parent reply other threads:[~2010-12-25 6:02 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-25 5:44 [bug #31969] omission in docs of scm_misc_error() anonymous
2010-12-25 6:02 ` Bake Timmons [this message]
2011-01-04 17:31 ` Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20101225-060254.sv66629.61618@savannah.gnu.org \
--to=invalid.noreply@gnu.org \
--cc=b3timmons@speedymail.org \
--cc=bug-guile@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).