From: Eli Zaretskii <eliz@gnu.org>
To: Doug Evans <dje@google.com>
Cc: palves@redhat.com, yao@codesourcery.com, gdb-patches@sourceware.org
Subject: Re: [PATCH 3/3, doc RFA] gdbserver debug_printf+timestamps: main patch
Date: Sat, 18 Jan 2014 08:25:00 -0000 [thread overview]
Message-ID: <83zjmtk87t.fsf@gnu.org> (raw)
In-Reply-To: <21209.45676.594470.76921@ruffy.mtv.corp.google.com>
> 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.
next prev parent reply other threads:[~2014-01-18 8:25 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-12-17 21:47 [PATCH 4/6] gdbserver: Delimit debugging output for readability Doug Evans
2013-12-18 11:17 ` Pedro Alves
2014-01-15 0:47 ` Doug Evans
2014-01-16 17:22 ` Pedro Alves
2014-01-16 18:43 ` Doug Evans
2014-01-16 18:54 ` Pedro Alves
2014-01-16 23:28 ` [PATCH 0/3] Add debug_printf and timestamps to gdbserver Doug Evans
2014-01-16 23:31 ` [PATCH 1/3] gdbserver debug_printf+timestamps: FUNCTION_NAME Doug Evans
2014-01-17 12:46 ` Pedro Alves
2014-01-16 23:33 ` [PATCH 2/3] gdbserver debug_printf+timestamps: delim_string_to_char_ptr_vec_append Doug Evans
2014-01-16 23:37 ` [PATCH 3/3, doc RFA] gdbserver debug_printf+timestamps: main patch Doug Evans
2014-01-17 2:58 ` Doug Evans
2014-01-17 7:04 ` Eli Zaretskii
2014-01-17 12:46 ` Pedro Alves
2014-01-17 22:45 ` Doug Evans
2014-01-18 8:25 ` Eli Zaretskii [this message]
2014-01-20 16:14 ` Pedro Alves
2014-01-22 23:06 ` Doug Evans
2014-01-16 18:39 ` [PATCH 4/6] gdbserver: Delimit debugging output for readability Yao Qi
2014-01-16 19:01 ` Doug Evans
2014-01-17 2:32 ` Joel Brobecker
2014-01-17 2:40 ` Joel Brobecker
2014-01-17 12:46 ` Pedro Alves
2014-01-17 12:59 ` Yao Qi
2014-01-20 5:42 ` Tom Tromey
2014-01-20 19:51 ` Doug Evans
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83zjmtk87t.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=dje@google.com \
--cc=gdb-patches@sourceware.org \
--cc=palves@redhat.com \
--cc=yao@codesourcery.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox