* [bug #31969] omission in docs of scm_misc_error()
@ 2010-12-25 5:44 anonymous
2010-12-25 6:02 ` Bake Timmons
0 siblings, 1 reply; 3+ messages in thread
From: anonymous @ 2010-12-25 5:44 UTC (permalink / raw)
To: bug-guile
URL:
<http://savannah.gnu.org/bugs/?31969>
Summary: omission in docs of scm_misc_error()
Project: Guile
Submitted by: None
Submitted on: Sat 25 Dec 2010 05:44:37 AM UTC
Category: None
Severity: 3 - Normal
Item Group: None
Status: None
Privacy: Public
Assigned to: None
Open/Closed: Open
Discussion Lock: Any
_______________________________________________________
Details:
The docs fail to mention scm_misc_error(). A suggested patch is attached.
Thanks,
Bake Timmons
b3timmons@speedymail.org
_______________________________________________________
Reply to this item at:
<http://savannah.gnu.org/bugs/?31969>
_______________________________________________
Message sent via/by Savannah
http://savannah.gnu.org/
^ permalink raw reply [flat|nested] 3+ messages in thread
* [bug #31969] omission in docs of scm_misc_error()
2010-12-25 5:44 [bug #31969] omission in docs of scm_misc_error() anonymous
@ 2010-12-25 6:02 ` Bake Timmons
2011-01-04 17:31 ` Ludovic Courtès
0 siblings, 1 reply; 3+ messages in thread
From: Bake Timmons @ 2010-12-25 6:02 UTC (permalink / raw)
To: Bake Timmons, bug-guile
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/
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [bug #31969] omission in docs of scm_misc_error()
2010-12-25 6:02 ` Bake Timmons
@ 2011-01-04 17:31 ` Ludovic Courtès
0 siblings, 0 replies; 3+ messages in thread
From: Ludovic Courtès @ 2011-01-04 17:31 UTC (permalink / raw)
To: Ludovic Courtès, Bake Timmons, bug-guile
Update of bug #31969 (project guile):
Status: None => Fixed
Open/Closed: Open => Closed
_______________________________________________________
Follow-up Comment #2:
Thanks, applied with minor changes.
_______________________________________________________
Reply to this item at:
<http://savannah.gnu.org/bugs/?31969>
_______________________________________________
Message sent via/by Savannah
http://savannah.gnu.org/
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2011-01-04 17:31 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-12-25 5:44 [bug #31969] omission in docs of scm_misc_error() anonymous
2010-12-25 6:02 ` Bake Timmons
2011-01-04 17:31 ` Ludovic Courtès
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).