This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH 3/3, doc RFA] gdbserver debug_printf+timestamps: main patch
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Doug Evans <dje at google dot com>
- Cc: palves at redhat dot com, yao at codesourcery dot com, gdb-patches at sourceware dot org
- Date: Sat, 18 Jan 2014 10:25:10 +0200
- Subject: Re: [PATCH 3/3, doc RFA] gdbserver debug_printf+timestamps: main patch
- Authentication-results: sourceware.org; auth=none
- References: <yjt2zjnztait dot fsf at ruffy dot mtv dot corp dot google dot com> <52B1842F dot 5020401 at redhat dot com> <21205 dot 55987 dot 69477 dot 892571 at ruffy dot mtv dot corp dot google dot com> <52D81569 dot 3080006 at redhat dot com> <CADPb22SK=YQeOcOdNPXERxXKOT2E64k=pHhw0GBiLj4LQhL-Ag at mail dot gmail dot com> <52D82AD5 dot 7000306 at redhat dot com> <21208 dot 27400 dot 695984 dot 88504 at ruffy dot mtv dot corp dot google dot com> <21208 dot 27945 dot 781450 dot 905336 at ruffy dot mtv dot corp dot google dot com> <52D92610 dot 4010202 at redhat dot com> <21209 dot 45676 dot 594470 dot 76921 at ruffy dot mtv dot corp dot google dot com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> From: Doug Evans <dje@google.com>
> Date: Fri, 17 Jan 2014 14:45:00 -0800
> cc: gdb-patches <gdb-patches@sourceware.org>
>
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -3,6 +3,14 @@
>
> *** Changes since GDB 7.7
>
> +* New features in the GDB remote stub, GDBserver
> +
> + ** New option --debug-format=option1[,option2,...] allows one to add
> + additional text to each debugging message. At present only timestamps
> + are supported: --debug-format=timestamps.
I stumbled on "debugging message". Why not say "to each output"
instead?
> +The @option{--debug-format=option1[,option2,...]} option tells
> +@code{gdbserver} to include additional information in each line of
> +debugging output. Possible options are:
Again, "each line of debugging output" is somewhat vague. (Aren't
there multi-line outputs, and if so, will gdbserver indeed precede
each of these lines with a timestamp?) I hope we can find something
more clear. Also, an example will help here.
Also, a @cindex entry here would be nice.
> @@ -44342,6 +44374,24 @@ Instruct @code{gdbserver} to display remote protocol debug output.
> This option is intended for @code{gdbserver} development and for bug reports to
> the developers.
>
> +@item --debug-format=option1@r{[},option2,...@r{]}
> +Instruct @code{gdbserver} to include extra information in each line
> +of debugging output.
> +
> +Possible options are:
Why is this described twice? I suggest to describe once, and leave a
cross-reference in the second place.
The documentation part is OK with these fixed.
Thanks.