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

[Hui Zhu]

On 11/22/12 01:36, Eli Zaretskii wrote:
>> Date: Wed, 21 Nov 2012 09:45:49 +0800
>> From: Hui Zhu <hui_zhu@mentor.com>
>>
>> This is the doc patch for the ctf read and write function.
>
> Thanks.
>
>> +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.
>
> We need to add here one or two sentences explaining what "CTF" stands
> for and perhaps giving a URL where the reader can learn more about
> that.
>
> The fact that we support CTF should also be in NEWS.
>
> Otherwise, OK.
>

Post a new version according to your comments.

Following part is for 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, do "target ctf <name>".

Thanks,
Hui
-------------- next part --------------
--- 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}
 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 +12078,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 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 @url{http://www.efficios.com/ctf}
+get more information about it.
 
 @kindex target tfile
 @kindex tfile
@@ -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.
+
 @end table
 
 @node Overlays