From 07ed89d61c2e23bcbfe10e27b5dcc01dcf7da051 Mon Sep 17 00:00:00 2001
From: Matthew Khouzam
Date: Fri, 30 Nov 2012 13:00:57 -0500
Subject: [PATCH] Update Documentation to better reflect branch
* Describe time stamp formatting
* Update descriptions of event views to editors
* Update images to reflect better timestamps
* Add description of events properties view
* Update Description of statistics view
* Recompress images
Change-Id: Ia00b76353ed6fb9fa8f81c819d2ff39ad3b78608
Signed-off-by: Matthew Khouzam
Reviewed-on: https://git.eclipse.org/r/8946
Reviewed-by: Bernd Hufmann
IP-Clean: Bernd Hufmann
Tested-by: Bernd Hufmann
Tested-by: Hudson CI
---
.../doc/Installation.html | 4 -
.../doc/LTTng-Kernel-Analysis.html | 20 ++--
.../doc/LTTng.html | 42 ++++----
.../doc/Limitations.html | 12 ++-
.../doc/Timestamp-formatting.html | 99 ++++++++++++++++++
.../doc/User-Guide-toc.xml | 5 +-
.../doc/User-Guide.mediawiki | 66 ++++++++----
.../doc/images/HistogramView.png | Bin 52773 -> 21213 bytes
.../doc/images/LTTng2EnvironmentsView.png | Bin 0 -> 21412 bytes
.../doc/images/LTTng2EventProperties.png | Bin 0 -> 20726 bytes
.../doc/images/LTTng2EventsEditor.png | Bin 0 -> 112951 bytes
.../doc/images/LTTng2StatisticsView.png | Bin 65762 -> 45391 bytes
.../doc/images/LTTngKernelPerspective.png | Bin 155332 -> 226846 bytes
.../doc/images/TmfTimestampFormatPage.png | Bin 0 -> 111880 bytes
org.eclipse.linuxtools.lttng.help/toc.xml | 6 +-
15 files changed, 190 insertions(+), 64 deletions(-)
create mode 100644 org.eclipse.linuxtools.lttng.help/doc/Timestamp-formatting.html
create mode 100644 org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EnvironmentsView.png
create mode 100644 org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventProperties.png
create mode 100644 org.eclipse.linuxtools.lttng.help/doc/images/LTTng2EventsEditor.png
create mode 100644 org.eclipse.linuxtools.lttng.help/doc/images/TmfTimestampFormatPage.png
diff --git a/org.eclipse.linuxtools.lttng.help/doc/Installation.html b/org.eclipse.linuxtools.lttng.help/doc/Installation.html
index dcbfe03c9c..48f623d749 100644
--- a/org.eclipse.linuxtools.lttng.help/doc/Installation.html
+++ b/org.eclipse.linuxtools.lttng.help/doc/Installation.html
@@ -47,10 +47,6 @@
The easiest way to install the LTTng plug-ins for Eclipse is through the Software Updates and Add-ons menu. For information on how to use this menu, refer to this
link.
- The legacy (
- Classic :-)) Eclipse LTTng (v0.x) is also available as an optional download. Refer to
- here for installation and verification instructions.
-
The LTTng plug-ins are structured as a stack of features/plug-ins as following:
-
diff --git a/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html b/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
index ad935d2661..930e4cd52b 100644
--- a/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
+++ b/org.eclipse.linuxtools.lttng.help/doc/LTTng-Kernel-Analysis.html
@@ -18,7 +18,7 @@
|
-
+
|
@@ -26,7 +26,7 @@
LTTng |
|
- Limitations |
+ Timestamp formatting |
LTTng Kernel Analysis
@@ -132,7 +132,7 @@
When the current time indicator is changed (when clicking in the states flow), all the other views are
synchronized. For example, the
- Events View will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
+ Events Editor will show the event matching the current time indicator. The reverse behaviour is also implemented: selecting an event within the Events View will update the Control Flow View current time indicator.
Incomplete regions
You'll notice
@@ -220,7 +220,7 @@
This view is also synchronized with the others :
histogram,
- events view,
+ Events editor,
control flow view, etc.
Navigation
@@ -244,10 +244,10 @@
Toolbar
.
- Events View
- The LTTng Kernel Events View
+
LTTng Kernel Events Editor
+ The LTTng Kernel Events editor
is the plain TMF
- Events Views except that it provide its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
+ Events Editor, except that it provides its own specialized viewer to replace the standard one. In short, it has exactly the same behaviour but the layout is slightly different:
-
+
@@ -279,7 +279,7 @@
-
+
|
@@ -287,7 +287,7 @@
LTTng |
|
- Limitations |
+ Timestamp formatting |