Update user guide for callsite and model lookup

Change-Id: If50ed7916a28e5cd126d7c525603e01e80150788
Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-on: https://git.eclipse.org/r/10540
Tested-by: Hudson CI
Reviewed-by: Bernd Hufmann <bhufmann@gmail.com>
IP-Clean: Bernd Hufmann <bhufmann@gmail.com>

diff --git a/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki b/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
index d811547fce4b2dc02c305868c778e36b370a4338..3efcbcdfbb10afe53afe4d3e51926f559bc8f94b 100644 (file)
--- a/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
+++ b/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
@@ -410,6 +410,18 @@ To remove a bookmark, double-click its icon, select '''Remove Bookmark''' from t
 
 [[Image:images/Bookmarks.png]]
 
+=== Event Source Lookup ===
+
+For CTF traces using specification v1.8.2 or above, information can optionally be embedded in the trace to indicate the source of a trace event. This is accessed through the event context menu by right-clicking on an event in the table.
+
+==== Callsite ====
+
+If a callsite is available in the trace for the selected event, the item '''Open Callsite''' is shown in the context menu. Selecting this menu item will attempt to find the callsite source file in all opened projects in the workspace. If multiple candidates exist, a selection dialog will be shown to the user. The selected source file will be opened in its default language editor. If no candidate is found, an error dialog is shown displaying the callsite information.
+
+==== EMF Model ====
+
+If an EMF model URI is available in the trace for the selected event, the item '''Open Model Element''' is shown in the context menu. Selecting this menu item will attempt to open the model file in the project specified in the URI. The model file will be opened in its default model editor. If the model file is not found, an error dialog is shown displaying the URI information.
+
 == Histogram View ==
 
 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.