lttng: Update user guide for histogram changes
authorPatrick Tasse <patrick.tasse@gmail.com>
Tue, 26 Nov 2013 15:58:22 +0000 (10:58 -0500)
committerPatrick Tasse <patrick.tasse@gmail.com>
Wed, 27 Nov 2013 18:29:53 +0000 (13:29 -0500)
Change-Id: Ia9b5cdab10f6444acd035f9f57ddac6031dbb8d3
Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-on: https://git.eclipse.org/r/18938
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
IP-Clean: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Tested-by: Hudson CI
org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png
org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png
org.eclipse.linuxtools.lttng.help/doc/images/TracingPerspective.png
org.eclipse.linuxtools.lttng.help/doc/images/link.gif [new file with mode: 0644]

index ec77959fb9f7b07e3691be243835e3647862eb4e..011cb4f8d55b8eb364531631755a88422835e731 100644 (file)
@@ -580,33 +580,48 @@ It is possible to export the content of the trace to a text file based on the co
 
 The Histogram View displays the trace events distribution with respect to time. When streaming a trace, this view is dynamically updated as the events are received.
 
-
 [[Image:images/HistogramView.png]]
 
 The '''Hide Lost Events''' toggle button [[Image:images/hide_lost_events.gif]] in the local toolbar allows to hide the bars of lost events. When the button is selected it can be toggled again to show the lost events.
 
-On the top left, there are two data controls:
+On the top left, there are three text controls:
+
+* '''Selection Start''': Displays the start time of the current selection
+* '''Selection End''': Displays the end time of the current selection
+* '''Window Span''': Displays the current zoom window size in seconds
+
+The controls can be used to modify their respective value. After validation, the other controls and views will be synchronized and updated accordingly. To modify both selection times simultaneously, press the link icon [[Image:images/link.gif]] which disables the '''Selection End''' control input.
+
+The large (full) histogram, at the bottom, shows the event distribution over the whole trace or set of traces. It also has a smaller semi-transparent orange window, with a cross-hair, that shows the current zoom window.
+
+The smaller (zoom) histogram, on top right, corresponds to the current zoom window, a sub-range of the event set.
+
+The x-axis of each histogram corresponds to the event timestamps. The start time and end time of the histogram range is displayed. The y-axis shows the maximum number of events in the corresponding histogram bars.
 
-* '''Current Event (sec)''': Displays the current time or selected time range begin time
-* '''Window Span (sec)''': Displays the current time range window size
+The vertical blue line(s) show the current selection time (or range). If applicable, the region in the selection range will be shaded.
 
-Both control can be used to modify their respective value. After validation, the other controls and views will be synchronized and updated accordingly.
+The mouse can be used to control the histogram:
 
-The large histogram, at the bottom, shows the event distribution over the whole trace or set of traces. It also has a smaller semi-transparent window, with a cross-hair, that shows the currently selected time range window. The time range window can be zoomed in/out by using the mouse wheel. It can also be selected by the mouse and dragged to another region of the trace.
+* '''Left-click''': Set a selection time
+* '''Left-drag''': Set a selection range
+* '''Shift-left-click or drag''': Extend or shrink the selection range
 
-The smaller histogram, on top right, corresponds to the currently selected time range window, a sub-range of the event set. Its size can also be zoomed in/out using the mouse wheel.
+* '''Middle-click or Ctrl-left-click''': Center the zoom window on mouse (full histogram only)
+* '''Middle-drag or Ctrl-left-drag''': Move the zoom window
 
-The x-axis of each histogram corresponds to the events timestamps. The timestamp of the first and the last event of the respective ranges is displayed. The y-axis of each histogram shows the minimum/maximum number of events in the corresponding histogram bars.
+* '''Right-drag''': Set the zoom window
+* '''Shift-right-click or drag''': Extend or shrink the zoom window (full histogram only)
 
-The dashed vertical magenta bar, on the right, shows the position of the last event. The vertical blue bar shows the currently selected time. The current time can be changed by clicking on the histogram. Shift-clicking the histogram will select a time range, in which case there will be vertical blue bars at the begin and end time and the region in between will be shaded.
+* '''Mouse wheel up''': Zoom in
+* '''Mouse wheel down''': Zoom out
 
-Hovering the mouse over an histogram bar pops up an information window that displays the start/end time of the corresponding bar as well as the number of events it represents.
+Hovering the mouse over an histogram bar pops up an information window that displays the start/end time of the corresponding bar, as well as the number of events (and lost events) it represents. If the mouse is over the selection range, the selection span in seconds is displayed.
 
 In each histogram, the following keys are handled:
 
-* '''Left''': Moves the current event to the previous non-empty bar
-* '''Right''': Moves the current event to the next non-empty bar
-* '''Home''': Sets the current time to the first histogram bar
+* '''Left Arrow''': Moves the current event to the previous non-empty bar
+* '''Right Arrow''': Moves the current event to the next non-empty bar
+* '''Home''': Sets the current time to the first non-empty bar
 * '''End''': Sets the current time to the last non-empty histogram bar
 
 == Statistics View ==
index 99410856dc72bf7eacc841aaf659aaae1fabbd8e..c972113fb1f8acdea8b3ed0fce9066fcb9fdeac3 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png and b/org.eclipse.linuxtools.lttng.help/doc/images/HistogramView.png differ
index deb85109f4310a60f3163ca4f42752cbf1d979d6..e68e369742db8d06dc05b0cd3864c17a726b00d1 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png and b/org.eclipse.linuxtools.lttng.help/doc/images/LTTngKernelPerspective.png differ
index fbcaf4913e91e76b1138ee7faefebf42794b013d..69b815578a4a2e1c882c4673672df6d3ebdaada0 100644 (file)
Binary files a/org.eclipse.linuxtools.lttng.help/doc/images/TracingPerspective.png and b/org.eclipse.linuxtools.lttng.help/doc/images/TracingPerspective.png differ
diff --git a/org.eclipse.linuxtools.lttng.help/doc/images/link.gif b/org.eclipse.linuxtools.lttng.help/doc/images/link.gif
new file mode 100644 (file)
index 0000000..e085688
Binary files /dev/null and b/org.eclipse.linuxtools.lttng.help/doc/images/link.gif differ
This page took 0.032275 seconds and 5 git commands to generate.