Re: RFA: Document RETURN_VALUE_ON_STACK

[Stan Shebs <shebs at apple dot com>]

Jim Blandy wrote:
> 
> Is this okay?

Your wording could be taken to mean that structures can't be
passed by value in C - I would say "(note that arrays are
passed by value in some languages, but not in C)" or something
like that.  Other than that it looks fine to me.

Stan

> Index: gdbint.texinfo
> ===================================================================
> RCS file: /cvs/cvsfiles/devo/gdb/doc/gdbint.texinfo,v
> retrieving revision 1.151
> diff -c -c -r1.151 gdbint.texinfo
> *** gdbint.texinfo      2000/04/16 14:54:43     1.151
> --- gdbint.texinfo      2000/04/18 19:53:19
> ***************
> *** 1875,1880 ****
> --- 1875,1888 ----
>   form.
>   @xref{Target Architecture Definition, , Using Different Register and Memory Data Representations}.
> 
> + @item RETURN_VALUE_ON_STACK(@var{type})
> + Return non-zero if values of type TYPE are returned on the stack, using
> + the ``struct convention''.  GDB assumes that structures, unions, arrays
> + passed by value (which never happens in C), and any other types this
> + predicate likes, might be returned in a struct-like fashion.  See the
> + function @code{using_struct_return} in @file{values.c} to see how this
> + gets used together with @code{USE_STRUCT_CONVENTION}.
> +
>   @item SOFTWARE_SINGLE_STEP_P
>   Define this as 1 if the target does not have a hardware single-step
>   mechanism. The macro @code{SOFTWARE_SINGLE_STEP} must also be defined.