bugGuile - Bugs: bug #31969, omission in docs of...

 
 

bug #31969: omission in docs of scm_misc_error()

Submitted by:  None
Submitted on:  Sat 25 Dec 2010 05:44:37 AM UTC  
 
Category: NoneSeverity: 3 - Normal
Item Group: NoneStatus: Fixed
Privacy: PublicAssigned to: None
Open/Closed: Closed

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Tue 04 Jan 2011 05:31:58 PM UTC, comment #2:

Thanks, applied with minor changes.

Ludovic Courtès <civodul>
Project Administrator
Sat 25 Dec 2010 06:02:54 AM UTC, comment #1:

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

Bake Timmons <bt3>
Sat 25 Dec 2010 05:44:37 AM UTC, original submission:

The docs fail to mention scm_misc_error(). A suggested patch is attached.
Thanks,
Bake Timmons
-unavailable-

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by civodul (Posted a comment)
  • -unavailable- added by bt3 (Posted a comment)
  • -unavailable- added by bt3
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Tue 04 Jan 2011 05:31:58 PM UTCcivodulStatusNone=>Fixed
      Open/ClosedOpen=>Closed
    Sat 25 Dec 2010 06:02:54 AM UTCbt3Carbon-Copy-=>Added bt3

    Back to the top


    Powered by Savane 3.1-cleanup1