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

[Hui Zhu]

On 11/28/12 10:44, Yao Qi wrote:
> On 11/28/2012 09:40 AM, Hui Zhu wrote:
>> --- a/doc/gdb.texinfo
>> +++ b/doc/gdb.texinfo
>> @@ -12069,7 +12069,7 @@ of trace data, via the @code{target tfil
>>   @table @code
>>
>>   @kindex tsave
>> -@item tsave [ -r ] @var{filename}
>> +@item tsave [ -r ] [-ctf] @var{filename}
>
> According patch 1/4 (function ctf_save), 'tsave -ctf foo' will save ctf files into directory 'foo'.  If so, we have to reflect this in document.
>
> Can we do 'tsave -r -ctf foo'?  IIRC, it is not allowed.
>
> It can be written something like this,
>
>    @item tsave [ -r ] @var{filename}
>    @itemx tsave [-ctf] @var{dirname}
>
>> @@ -12089,6 +12095,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{filename}
>> +Use the file named @var{filename} as a source of CTF trace data.
>> +
>
> According to patch 3/4 (function init_ctf_ops), 'target ctf foo' uses directory foo instead of file foo.
>

Post a new version according to your comments.

Thanks,
Hui
-------------- next part --------------
--- 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,6 +12079,12 @@ 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
@@ -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
 
 @node Overlays