From 39191d766d9f673e5951e82b63c7a97fb570479e Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Tue, 3 Feb 2015 19:39:43 -0500 Subject: [PATCH] doc: Add a TOC to the longer guides This will help the HTML (non-Eclipse-help) version much easier to navigate. Change-Id: I0e77af7b10fe16863998c6f836d576ce682761dc Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/41032 Reviewed-by: Hudson CI Reviewed-by: Bernd Hufmann Tested-by: Bernd Hufmann --- .../doc/Developer-Guide.mediawiki | 4 ++++ .../doc/User-Guide.mediawiki | 4 ++++ .../doc/User-Guide.mediawiki | 5 +++++ .../doc/User-Guide.mediawiki | 1 + 4 files changed, 14 insertions(+) diff --git a/doc/org.eclipse.tracecompass.doc.dev/doc/Developer-Guide.mediawiki b/doc/org.eclipse.tracecompass.doc.dev/doc/Developer-Guide.mediawiki index ee56c51395..507f322aca 100644 --- a/doc/org.eclipse.tracecompass.doc.dev/doc/Developer-Guide.mediawiki +++ b/doc/org.eclipse.tracecompass.doc.dev/doc/Developer-Guide.mediawiki @@ -1,4 +1,8 @@ += Table of Contents = + +__TOC__ + = Introduction = The purpose of the '''Tracing Monitoring Framework (TMF)''' is to facilitate the integration of tracing and monitoring tools into Eclipse, to provide out-of-the-box generic functionalities/views and provide extension mechanisms of the base functionalities for application specific purposes. diff --git a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/doc/User-Guide.mediawiki b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/doc/User-Guide.mediawiki index 088c955cc3..546af80bc8 100644 --- a/doc/org.eclipse.tracecompass.gdbtrace.doc.user/doc/User-Guide.mediawiki +++ b/doc/org.eclipse.tracecompass.gdbtrace.doc.user/doc/User-Guide.mediawiki @@ -1,4 +1,8 @@ += Table of Contents = + +__TOC__ + = Overview = The GDB Tracepoint Analysis feature is an extension to the Tracing and Monitoring Framework that allows the visualization and analysis of C/C++ tracepoint data collected by GDB and stored to a log file. diff --git a/doc/org.eclipse.tracecompass.rcp.doc.user/doc/User-Guide.mediawiki b/doc/org.eclipse.tracecompass.rcp.doc.user/doc/User-Guide.mediawiki index cae3cbfafd..edd314f446 100644 --- a/doc/org.eclipse.tracecompass.rcp.doc.user/doc/User-Guide.mediawiki +++ b/doc/org.eclipse.tracecompass.rcp.doc.user/doc/User-Guide.mediawiki @@ -1,10 +1,13 @@ + = Overview = + The Trace Compass RCP version is a stand-alone application based on Eclipse's Rich Client Platform (RCP). The purpose of this is to provide a lightweight application to view and analyze traces. It includes most standard features found in the Trace Compass project. = Getting Started = + To start the Trace Compass RCP, go to the directory where it is installed and then run the executable named '''tracecompass'''. During startup, the program will create, if necessary, an Eclipse workspace under the user's home directory @@ -15,6 +18,7 @@ Now the application can be used as described in the regular User Guide. (see section [[#References | References]]). = Updating the application = + The RCP is pre-configured to point to the update site of its release "track". For example, if you download a "nightly" RCP, it will update using that "nightly" update site. These settings are configurable in the preferences, but @@ -25,6 +29,7 @@ click on '''Help''' -> '''Check for Updates'''. If updates are available, a standard Eclipse update dialog will offer their installation. = Opening a Trace = + To open a trace, click on the '''File''' menu and select '''Open Trace...'''. A new dialog will show up for selecting a trace to open. Select a trace file and then click on '''OK'''. Note that for traces that are directories diff --git a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/doc/User-Guide.mediawiki b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/doc/User-Guide.mediawiki index a0c0d5203a..da19dd00c5 100644 --- a/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/doc/User-Guide.mediawiki +++ b/doc/org.eclipse.tracecompass.tmf.pcap.doc.user/doc/User-Guide.mediawiki @@ -1,3 +1,4 @@ + = Pcap Support Within TMF = TMF now supports the reading of libpcap files for network tracing. Those files contains packets that were seen on a network, have a .pcap or .cap extension and can be captured with tools like Wireshark/Tshark/Tcpdump. To open a libpcap trace, simply import it just like any other trace type and TMF will recognize the format. Open the imported trace to see the packets that were captured. For more information about generic features of TMF see the [http://wiki.eclipse.org/index.php/Linux_Tools_Project/LTTng2/User_Guide User Guide]. -- 2.34.1