lttng: Update Control Flow and Resources view user guide
authorBernd Hufmann <Bernd.Hufmann@ericsson.com>
Fri, 24 May 2013 19:43:35 +0000 (15:43 -0400)
committerBernd Hufmann <bernd.hufmann@ericsson.com>
Mon, 27 May 2013 13:17:37 +0000 (09:17 -0400)
Change-Id: Idcde718294d0307ed3805ebf6f084ef7bb504bf6
Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/13140
Tested-by: Hudson CI
Reviewed-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
IP-Clean: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Tested-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
org.eclipse.linuxtools.lttng.help/doc/images/Cfv_legend.png
org.eclipse.linuxtools.lttng.help/doc/images/Cfv_toolbar.png
org.eclipse.linuxtools.lttng.help/doc/images/Cfv_tooltip.png
org.eclipse.linuxtools.lttng.help/doc/images/LTTng2_CFV_Filter.png [new file with mode: 0644]
org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox1.png
org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox2.png
org.eclipse.linuxtools.lttng.help/doc/images/Rv_example.png
org.eclipse.linuxtools.lttng.help/doc/images/Rv_legend.png
org.eclipse.linuxtools.lttng.help/doc/images/Rv_toolbar.png [new file with mode: 0644]

index 6129bacf800971095db2d189949e16737077e39e..180777ae98d90d1b73a11a4685ef014b942ea094 100644 (file)
@@ -5,7 +5,7 @@ LTTng (Linux Trace Toolkit, next generation) is a highly efficient tracing tool
 
 For more information about LTTng, refer to the project [http://lttng.org site]
 
-'''Note''': This User Guide covers the integration of the latest LTTng (v2.0) in Eclipse. The legacy version (v0.x) of both the tracer and the LTTng integration are no longer being maintained but are still available for download. The User Guide for the legacy LTTng integration is available [http://wiki.eclipse.org/index.php/Linux_Tools_Project/LTTng/User_Guide here].
+'''Note''': This User Guide covers the integration of the latest LTTng (v2.0) in Eclipse. The legacy version (v0.x) of both the tracer and the LTTng integration are no longer being maintained.
 
 == About Tracing ==
 
@@ -1274,7 +1274,7 @@ The TID column shows the process node's '''thread ID''' and the PTID column show
 
 This part of the Control Flow View is probably the most interesting one. Using the mouse, you can navigate through the trace (go left, right) and zoom on a specific region to inspect its details.
 
-The colored bars you see represent '''states''' for the associated process node. When a process state changes in time, so does the color. States colors legend is available through a [[#Toolbar|toolbar button]]:
+The colored bars you see represent '''states''' for the associated process node. When a process state changes in time, so does the color. For state '''SYSCALL''' the name of the system call is displayed in the state bar. States colors legend is available through a [[#Toolbar|toolbar button]]:
 
 [[Image:images/Cfv_legend.png]]
 
@@ -1340,12 +1340,17 @@ The '''Previous event''' and '''Next event''' buttons update the current time in
 
 The '''Previous process''' and '''Next process''' buttons select the previous and next process node within the process tree.
 
+The '''Process filter''' buttons opens a new dialog box for configuring the processes to show.
+
+[[Image:images/LTTng2_CFV_Filter.png]]
+
 == Resources View ==
 This view is specific to kernel trace. To open it, go in '''Window''' -> '''Show View''' -> '''Other...''' and select '''LTTng/Resources''' in the list.
 
-[[Image:images/Rv example.png| Example of resources view with all trace points and syscalls enabled]]
+[[Image:images/Rv_example.png| Example of resources view with all trace points and syscalls enabled]]
 
-This view shows the state of system resources i.e. if changes occured during the trace either on '''CPUs''', '''IRQs''' or '''soft IRQs''', it will appear in this view. The left side of the view present a list of resources that are affected by at least one event of the trace. The right side illustrate the state in which each resource is at some point in time.
+This view shows the state of system resources i.e. if changes occured during the trace either on '''CPUs''', '''IRQs''' or '''soft IRQs''', it will appear in this view. The left side of the view present a list of resources that are affected by at least one event of the trace. The right side illustrate the state in which each resource is at some point in time. For state '''USERMODE''' it also prints the process name in the state bar. For state '''SYSCALL''' the name of the system call is
+displayed in the state region.
 
 Just like other views, according to which trace points and system calls are activated, the content of this view may change from one trace to another.
 
@@ -1361,7 +1366,7 @@ Then, by selecting '''Next Event''', it will show the next state transition and
 
 [[Image:images/RV_infobox2.png|Shows the next state of the IRQ]]
 
-This view is also synchronized with the others : [[#Histogram_View | histogram]], [[#LTTng_Kernel_Events_Editor | Events editor]], [[#Control_Flow_View | control flow view]], etc.
+This view is also synchronized with the others : [[#Histogram_View | Histogram View]], [[#LTTng_Kernel_Events_Editor | Events Editor]], [[#Control_Flow_View | Control Flow View]], etc.
 
 === Navigation ===
 
@@ -1373,7 +1378,13 @@ See Control Flow View's '''[[#Incomplete_regions|Incomplete regions]]'''.
 
 === Toolbar ===
 
-See Control Flow View's '''[[#Toolbar|Toolbar]]'''.
+The Resources View '''toolbar''', located at the top right of the view, has shortcut buttons to perform common actions:
+
+[[Image:images/Rv_toolbar.png]]
+
+The '''Previous event''' and '''Next event''' buttons update the current time indicator so that it's on the previous or next event.
+
+The '''Previous resource''' and '''Next resource''' buttons select the previous and next resource node within the resource tree.
 
 == LTTng Kernel Events Editor ==
 
index 740108773c3724d1a75a394c73beb9c81d1ae98b..5749d72b726562e46f8d9488095c502f6b9eeb11 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_legend.png and b/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_legend.png differ
index 93ed6e6f71b03254efdd6d9353a49c49485432ea..6198ea860d1b2cb7edd3c317ec40a2fe75a4cf35 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_toolbar.png and b/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_toolbar.png differ
index 1a6034b590752c77dfd54137f2ca35a5ad5ad21c..d74a5c63bd972640ea8961efb7332bf457e3abed 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_tooltip.png and b/org.eclipse.linuxtools.lttng.help/doc/images/Cfv_tooltip.png differ
diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2_CFV_Filter.png b/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2_CFV_Filter.png
new file mode 100644 (file)
index 0000000..9665f16
Binary files /dev/null and b/org.eclipse.linuxtools.lttng.help/doc/images/LTTng2_CFV_Filter.png differ
index f0898c2e8ee58924b16bb5d2b8cf908fff9fc0b0..0d38a9a3a1a1e2e65ee27051d7dbb58fd5f6b2c5 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox1.png and b/org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox1.png differ
index 7adae95fbba51ac64ec494b6fc6e083a34db8846..fc4d33d69a19e7e3e50623421a8e22a09750112f 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox2.png and b/org.eclipse.linuxtools.lttng.help/doc/images/RV_infobox2.png differ
index 75caf00f1a15db305f842494dfdd4fb3c3f84f4f..702fcee8cb3fc931bac376e0f4e144095727f304 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/Rv_example.png and b/org.eclipse.linuxtools.lttng.help/doc/images/Rv_example.png differ
index 2f6e42d0332e662011b4c7f668dead97bf5b635c..e946becdcda8b7a6c157dbd1c3cbd7f866c73375 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/Rv_legend.png and b/org.eclipse.linuxtools.lttng.help/doc/images/Rv_legend.png differ
diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/Rv_toolbar.png b/org.eclipse.linuxtools.lttng.help/doc/images/Rv_toolbar.png
new file mode 100644 (file)
index 0000000..21e211a
Binary files /dev/null and b/org.eclipse.linuxtools.lttng.help/doc/images/Rv_toolbar.png differ
This page took 0.044488 seconds and 5 git commands to generate.