tmf: Update User Guide for custom parser category support

Change-Id: Idce7640b0e8ff0475dc0ffaf4e29a74475730124
Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-on: https://git.eclipse.org/r/33079
Reviewed-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Tested-by: Hudson CI

diff --git a/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki b/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
index 4ffd98c95fef7edc7653fc6f2ee0f345d280948a..738d7e5e0e7218566cb6e859eb1346c1a111dbd3 100644 (file)
--- a/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
+++ b/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
@@ -721,7 +721,8 @@ The '''New Custom Text Parser''' wizard can be used to create a custom parser fo
 
 Fill out the first wizard page with the following information:
 
-* '''Log type:''' Enter a name for the custom log entries, which is also the name of the custom parser.
+* '''Category:''' Enter a category name for the trace type.
+* '''Trace type:''' Enter a name for the trace type, which is also the name of the custom parser.
 * '''Time Stamp format:''' Enter the date and time pattern that will be used to output the Time Stamp.<br>
 Note: information about date and time patterns can be found here: [../reference/api/org/eclipse/linuxtools/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
 
@@ -788,7 +789,8 @@ The '''New Custom XML Parser''' wizard can be used to create a custom parser for
 
 Fill out the first wizard page with the following information:
 
-* '''Log type:''' Enter a name for the custom log entries, which is also the name of the custom parser.
+* '''Category:''' Enter a category name for the trace type.
+* '''Trace type:''' Enter a name for the trace type, which is also the name of the custom parser.
 * '''Time Stamp format:''' Enter the date and time pattern that will be used to output the Time Stamp.<br>
 
 Note: information about date and time patterns can be found here: [../reference/api/org/eclipse/linuxtools/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
@@ -877,7 +879,7 @@ Select a custom parser from the list and click the '''Delete''' button to remove
 
 * Import...
 
-Click the '''Import...''' button and select a file from the opened file dialog to import all its custom parsers.
+Click the '''Import...''' button and select a file from the opened file dialog to import all its custom parsers. If any parser conflicts with an existing built-in or custom trace type, the user will be prompted to skip or rename the imported parser.
 
 * Export...
 
@@ -890,7 +892,7 @@ Once a custom parser has been created, any [[#Importing Traces to the Project|im
 To do so:
 
 * Select a trace in the '''Project Explorer''' view
-* Right-click the trace and select '''Select Trace Type...''' &gt; '''Custom Text''' or '''Custom XML''' &gt; ''parser name''
+* Right-click the trace and select '''Select Trace Type...''' &gt; ''category name'' &gt; ''parser name''
 * Double-click the trace or right-click it and select '''Open'''
 
 The trace will be opened in an editor showing the events table, and an entry will be added for it in the Time Chart view.

diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserInput.png b/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserInput.png
index fab35bcb2c9bb970020cdb95a67194c2bf463878..239dc118d3728342ac59552efbd493db3000d023 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserInput.png and b/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserInput.png differ

diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserOutput.png b/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserOutput.png
index b2105f6bf6adb0557189d8bb0f357eed536ba973..e1d01bbf18295c2d4507afa3d13979e7ba1e463c 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserOutput.png and b/org.eclipse.linuxtools.lttng.help/doc/images/CustomTextParserOutput.png differ

diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserInput.png b/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserInput.png
index e920f70c1dbe249711b010121cd6a7e8fe5a8cdf..3e861b4e1d7efb916b1bd1c096c47b87a1511f15 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserInput.png and b/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserInput.png differ

diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserOutput.png b/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserOutput.png
index e776375a4c77e2fb1a4089a0e679427be09fc374..fb0a1492b13d3a680789c69ab97dae69ef4d86bd 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserOutput.png and b/org.eclipse.linuxtools.lttng.help/doc/images/CustomXMLParserOutput.png differ

diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/ManageCustomParsers.png b/org.eclipse.linuxtools.lttng.help/doc/images/ManageCustomParsers.png
index e3fcd9149ef35a50e7780b21ad13218f19a2fddb..cce4cf47d0eae8c1da8083309218644b1769dac6 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/ManageCustomParsers.png and b/org.eclipse.linuxtools.lttng.help/doc/images/ManageCustomParsers.png differ