[Guile-commits] 02/02: Fix doc for string args to error C API

[Daniel Llorens]

lloda pushed a commit to branch main
in repository guile.

commit d1a4b101bf66c5ba62b1c5c26dd1b48526908ede
Author: Daniel Llorens <lloda@sarc.name>
AuthorDate: Fri Sep 30 12:04:15 2022 +0200

    Fix doc for string args to error C API
---
 doc/ref/api-control.texi | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/ref/api-control.texi b/doc/ref/api-control.texi
index 88dea5623..087e79515 100644
--- a/doc/ref/api-control.texi
+++ b/doc/ref/api-control.texi
@@ -2269,12 +2269,12 @@ expression library.
 In the following C functions, @var{SUBR} and @var{MESSAGE} parameters
 can be @code{NULL} to give the effect of @code{#f} described above.
 
-@deftypefn {C Function} SCM scm_error (SCM @var{key}, char *@var{subr}, char 
*@var{message}, SCM @var{args}, SCM @var{rest})
+@deftypefn {C Function} SCM scm_error (SCM @var{key}, const char *@var{subr}, 
const char *@var{message}, SCM @var{args}, SCM @var{rest})
 Throw an error, as per @code{scm-error} (@pxref{Error Reporting}).
 @end deftypefn
 
-@deftypefn {C Function} void scm_syserror (char *@var{subr})
-@deftypefnx {C Function} void scm_syserror_msg (char *@var{subr}, char 
*@var{message}, SCM @var{args})
+@deftypefn {C Function} void scm_syserror (const char *@var{subr})
+@deftypefnx {C Function} void scm_syserror_msg (const char *@var{subr}, const 
char *@var{message}, SCM @var{args})
 Throw an error with key @code{system-error} and supply @code{errno} in
 the @var{rest} argument.  For @code{scm_syserror} the message is
 generated using @code{strerror}.
@@ -2283,11 +2283,11 @@ Care should be taken that any code in between the 
failing operation
 and the call to these routines doesn't change @code{errno}.
 @end deftypefn
 
-@deftypefn {C Function} void scm_num_overflow (char *@var{subr})
-@deftypefnx {C Function} void scm_out_of_range (char *@var{subr}, SCM 
@var{bad_value})
+@deftypefn {C Function} void scm_num_overflow (const char *@var{subr})
+@deftypefnx {C Function} void scm_out_of_range (const char *@var{subr}, SCM 
@var{bad_value})
 @deftypefnx {C Function} void scm_wrong_num_args (SCM @var{proc})
-@deftypefnx {C Function} void scm_wrong_type_arg (char *@var{subr}, int 
@var{argnum}, SCM @var{bad_value})
-@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_wrong_type_arg (const char *@var{subr}, int 
@var{argnum}, SCM @var{bad_value})
+@deftypefnx {C Function} void scm_wrong_type_arg_msg (const char *@var{subr}, 
int @var{argnum}, SCM @var{bad_value}, const char *@var{expected})
 @deftypefnx {C Function} void scm_misc_error (const char *@var{subr}, const 
char *@var{message}, SCM @var{args})
 Throw an error with the various keys described above.