Re: [PATCH] Add CTF support to GDB [4/4] doc

[Hui Zhu <teawater@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2014 bytes --]

On Wed, Nov 28, 2012 at 1:25 PM, Yao Qi <yao@codesourcery.com> wrote:
> On 11/28/2012 12:56 PM, Hui Zhu wrote:
>>
>> +By default, this command will save trace frame into tfile format.
>> +You can supply the optional argument @code{-ctf} to save date in CTF
>
>                                                             ^^^^ typo.
>
>> @@ -12089,6 +12096,11 @@ the state of the trace run at the moment
>>
>>   as the current trace frame you are examining.  @var{filename} must be
>>   on a filesystem accessible to the host.
>>
>> +@kindex target ctf
>> +@kindex ctf
>> +@item target ctf @var{dirname}
>> +Use the directory named @var{dirname} as a source of CTF trace data.
>> +
>>   @end table
>
>
> I am not good at documentation, but I feel that it might be better to
> combine the doc for 'target tfile' and 'target ctf' together, because they
> (should) behave almost the same to users, how about this?
>
> @kindex target tfile
> @kindex tfile
> @item target tfile @var{filename}
> @kindex target ctf
> @kindex ctf
> @itemx target ctf @var{dirname}
> Use the file named @var{filename} or directory named @var{dirname} as a
> source of trace data.  Commands
> that examine data work as they do with a live target, but it is not
> possible to run any new trace experiments.  @code{tstatus} will report
> the state of the trace run at the moment the data was saved, as well
> as the current trace frame you are examining.  @var{filename} or
> @var{dirname} must be
>
> on a filesystem accessible to the host.
>
> I have no other comments.
>
> --
> Yao (齐尧)

I think that is better.  Post a new version according to your comments.

Thanks,
Hui

News:
* GDB now has the ability to read and write trace buffer in common trace
  format (CTF).  To create a CTF trace file, use "tsave -ctf <filename>",
  and to use it, type "target ctf <name>".

2012-11-28  Hui Zhu  <hui_zhu@mentor.com>

	* gdb.texinfo (Trace Files): Add "tsave -ctf" and target ctf.

[-- Attachment #2: ctf-doc.txt --]
[-- Type: text/plain, Size: 2065 bytes --]

--- a/doc/gdb.texinfo
+++ b/doc/gdb.texinfo
@@ -12070,6 +12070,7 @@ of trace data, via the @code{target tfil
 
 @kindex tsave
 @item tsave [ -r ] @var{filename}
+@itemx tsave [-ctf] @var{dirname}
 Save the trace data to @var{filename}.  By default, this command
 assumes that @var{filename} refers to the host filesystem, so if
 necessary @value{GDBN} will copy raw trace data up from the target and
@@ -12078,16 +12079,26 @@ optional argument @code{-r} (``remote'')
 the data directly into @var{filename} in its own filesystem, which may be
 more efficient if the trace buffer is very large.  (Note, however, that
 @code{target tfile} can only read from files accessible to the host.)
+By default, this command will save trace frame into tfile format.
+You can supply the optional argument @code{-ctf} to save date in CTF
+format.  The @dfn{Common Trace Format} (CTF) is proposed as a trace format
+that suits the needs of the embedded, telecom, high-performance
+and kernel communities.  Please goto @indicateurl{http://www.efficios.com/ctf}
+to get more information.
 
 @kindex target tfile
 @kindex tfile
 @item target tfile @var{filename}
-Use the file named @var{filename} as a source of trace data.  Commands
-that examine data work as they do with a live target, but it is not
-possible to run any new trace experiments.  @code{tstatus} will report
-the state of the trace run at the moment the data was saved, as well
-as the current trace frame you are examining.  @var{filename} must be
-on a filesystem accessible to the host.
+@kindex target ctf
+@kindex ctf
+@itemx target ctf @var{dirname}
+Use the file named @var{filename} or directory named @var{dirname} as
+a source of trace data.  Commands that examine data work as they do with
+a live target, but it is not possible to run any new trace experiments.
+@code{tstatus} will report the state of the trace run at the moment
+the data was saved, as well as the current trace frame you are examining.
+@var{filename} or @var{dirname} must be on a filesystem accessible to
+the host.
 
 @end table