Re: [RFA/doco] Document "set/show print frame-arguments"

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Fri, 9 Nov 2007 11:13:00 -0800
> From: Joel Brobecker <brobecker@adacore.com>
> 
> Here is the documentation related to the "set/show print frame-arguments"
> that I recently added.

Thanks!

> I am debating whether the last paragraphe should be merged with the
> first one, or not...

It could be either way, I think.

> +@item set print frame-arguments @var{value}
> +This command allows to control how the value of arguments are printed
> +when the debugger prints a frame (@pxref{Frames}).  The possible
> +values are:

Some @cindex entry here would be useful, I think.  Please think what
phrase(s) you would try to use to look up this subject in the index,
and add index entries with those phrases.

> +@item all
> +The value of all arguments is printed.  This is the default.

I think you should use "values", in plural.  And likewise above, in
the description of the command: "value of arguments are printed"
doesn't sound right.

> +Print the value of an argument only if it is a scalar.  The value of more
> +complex arguments such as arrays, structures, unions, etc, is replaced
> +by @code{...}. Here is an example where only scalar arguments are shown:

Please use @dots{} here and elsewhere, it looks better in print.

> +@smallexample
> +#1  0x08048361 in call_me (i=3, s=..., ss=0xbf8d508c, u=..., e=green) at frame-args.c:23
> +@end smallexample

This line is too long, it will overflow the page margins.  Please
break it into two line, each one preferably shorter than 70
characters.

> +is replaced by @code{...}. In this case, the example above now becomes:
                            ^^
Two spaces after a period that ends a sentence, here and elsewhere,
please.

> +By default, all argument values are always printed. But this command
> +can be useful to make a backtrace more readable, for instance, by
> +reducing the amount of information printed for each frame, particularly
> +when large objects would normally be printed.

Don't you want to mention the Adacore case, which was the reason for
this feature?

> +
> +@item show print frame-arguments
> +Show how the value of arguments should be displayed when printing a frame.
> +
>  @item show print repeats
>  Display the current threshold for printing repeated identical
>  elements.
> 
> --WYTEVAkct0FjGQmd--
>