[3/3] gdb/doc: Add documentation for tfile description section lines.
Commit Message
gdb/doc/ChangeLog:
* gdb.texinfo (Trace File Format): Add documentation for description
section lines.
---
Here's the promised documentation for tdesc lines and then some.
gdb/doc/ChangeLog | 5 +++++
gdb/doc/gdb.texinfo | 33 ++++++++++++++++++++++++++++++++-
2 files changed, 37 insertions(+), 1 deletion(-)
Comments
On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
> gdb/doc/ChangeLog:
>
> * gdb.texinfo (Trace File Format): Add documentation for description
> section lines.
> ---
> Here's the promised documentation for tdesc lines and then some.
Excellent! Thanks much.
Looks good to me content-wise, but let's get an ack from Eli as well.
On 10/02/16 23:20, Pedro Alves wrote:
> On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
>> gdb/doc/ChangeLog:
>>
>> * gdb.texinfo (Trace File Format): Add documentation for description
>> section lines.
>> ---
>> Here's the promised documentation for tdesc lines and then some.
>
> Excellent! Thanks much.
>
> Looks good to me content-wise, but let's get an ack from Eli as well.
>
Ping?
[+Eli]
Original at:
https://sourceware.org/ml/gdb-patches/2016-02/msg00320.html
Thanks,
Pedro Alves
On 02/17/2016 09:50 AM, Marcin Kościelnicki wrote:
> On 10/02/16 23:20, Pedro Alves wrote:
>> On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
>>> gdb/doc/ChangeLog:
>>>
>>> * gdb.texinfo (Trace File Format): Add documentation for description
>>> section lines.
>>> ---
>>> Here's the promised documentation for tdesc lines and then some.
>>
>> Excellent! Thanks much.
>>
>> Looks good to me content-wise, but let's get an ack from Eli as well.
>>
>
> Ping?
>
[Really +Eli ...]
Thanks,
Pedro Alves
On 02/17/2016 03:37 PM, Pedro Alves wrote:
> [+Eli]
>
> Original at:
> https://sourceware.org/ml/gdb-patches/2016-02/msg00320.html
>
> Thanks,
> Pedro Alves
>
> On 02/17/2016 09:50 AM, Marcin Kościelnicki wrote:
>> On 10/02/16 23:20, Pedro Alves wrote:
>>> On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
>>>> gdb/doc/ChangeLog:
>>>>
>>>> * gdb.texinfo (Trace File Format): Add documentation for description
>>>> section lines.
>>>> ---
>>>> Here's the promised documentation for tdesc lines and then some.
>>>
>>> Excellent! Thanks much.
>>>
>>> Looks good to me content-wise, but let's get an ack from Eli as well.
>>>
>>
>> Ping?
>>
>
> Cc: gdb-patches@sourceware.org
> From: Marcin Kościelnicki <koriakin@0x04.net>
> Date: Wed, 17 Feb 2016 10:50:05 +0100
>
> On 10/02/16 23:20, Pedro Alves wrote:
> > On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
> >> gdb/doc/ChangeLog:
> >>
> >> * gdb.texinfo (Trace File Format): Add documentation for description
> >> section lines.
> >> ---
> >> Here's the promised documentation for tdesc lines and then some.
> >
> > Excellent! Thanks much.
> >
> > Looks good to me content-wise, but let's get an ack from Eli as well.
> >
>
> Ping?
Sorry, missed that.
The patch is OK, but I wonder what about that FIXME there?
Thanks.
On 17/02/16 16:59, Eli Zaretskii wrote:
>> Cc: gdb-patches@sourceware.org
>> From: Marcin Kościelnicki <koriakin@0x04.net>
>> Date: Wed, 17 Feb 2016 10:50:05 +0100
>>
>> On 10/02/16 23:20, Pedro Alves wrote:
>>> On 02/10/2016 08:19 PM, Marcin Kościelnicki wrote:
>>>> gdb/doc/ChangeLog:
>>>>
>>>> * gdb.texinfo (Trace File Format): Add documentation for description
>>>> section lines.
>>>> ---
>>>> Here's the promised documentation for tdesc lines and then some.
>>>
>>> Excellent! Thanks much.
>>>
>>> Looks good to me content-wise, but let's get an ack from Eli as well.
>>>
>>
>> Ping?
>
> Sorry, missed that.
>
> The patch is OK, but I wonder what about that FIXME there?
>
> Thanks.
>
Yeah, the FIXME is worded a bit weirdly and I wondered about it too, but
the only thing it could've referred to was the description section line
types (the trace frame section is already documented), so I figured it'd
be best to remove it.
On 02/17/2016 04:04 PM, Marcin Kościelnicki wrote:
> On 17/02/16 16:59, Eli Zaretskii wrote:
>> The patch is OK, but I wonder what about that FIXME there?
>>
>> Thanks.
>>
>
> Yeah, the FIXME is worded a bit weirdly and I wondered about it too, but
> the only thing it could've referred to was the description section line
> types (the trace frame section is already documented), so I figured it'd
> be best to remove it.
>
I agree.
Thanks,
Pedro Alves
On 17/02/16 17:05, Pedro Alves wrote:
> On 02/17/2016 04:04 PM, Marcin Kościelnicki wrote:
>> On 17/02/16 16:59, Eli Zaretskii wrote:
>
>>> The patch is OK, but I wonder what about that FIXME there?
>>>
>>> Thanks.
>>>
>>
>> Yeah, the FIXME is worded a bit weirdly and I wondered about it too, but
>> the only thing it could've referred to was the description section line
>> types (the trace frame section is already documented), so I figured it'd
>> be best to remove it.
>>
>
> I agree.
>
> Thanks,
> Pedro Alves
>
I've pushed the patch.
@@ -1,5 +1,10 @@
2016-02-10 Marcin Kościelnicki <koriakin@0x04.net>
+ * gdb.texinfo (Trace File Format): Add documentation for description
+ section lines.
+
+2016-02-10 Marcin Kościelnicki <koriakin@0x04.net>
+
* gdb.texinfo (Trace File Format): Remove misleading information
about register block ordering.
@@ -41031,7 +41031,38 @@ as tracepoint definitions or register set size. @value{GDBN} will
ignore any line that it does not recognize. An empty line marks the end
of this section.
-@c FIXME add some specific types of data
+@table @code
+@item R @var{size}
+Specifies the size of a register block in bytes. This is equal to the
+size of a @code{g} packet payload in the remote protocol. @var{size}
+is an ascii decimal number. There should be only one such line in
+a single trace file.
+
+@item status @var{status}
+Trace status. @var{status} has the same format as a @code{qTStatus}
+remote packet reply. There should be only one such line in a single trace
+file.
+
+@item tp @var{payload}
+Tracepoint definition. The @var{payload} has the same format as
+@code{qTfP}/@code{qTsP} remote packet reply payload. A single tracepoint
+may take multiple lines of definition, corresponding to the multiple
+reply packets.
+
+@item tsv @var{payload}
+Trace state variable definition. The @var{payload} has the same format as
+@code{qTfV}/@code{qTsV} remote packet reply payload. A single variable
+may take multiple lines of definition, corresponding to the multiple
+reply packets.
+
+@item tdesc @var{payload}
+Target description in XML format. The @var{payload} is a single line of
+the XML file. All such lines should be concatenated together to get
+the original XML file. This file is in the same format as @code{qXfer}
+@code{features} payload, and corresponds to the main @code{target.xml}
+file. Includes are not allowed.
+
+@end table
The trace frame section consists of a number of consecutive frames.
Each frame begins with a two-byte tracepoint number, followed by a