Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOtavio Pontes2012-07-13 15:23:42 -0400
committerOtavio Pontes2012-07-16 17:11:45 -0400
commitc982d2b3399f183791f6ccb52face97878d03454 (patch)
tree0ad678b0f9ad94042651781982fb88c3bf41d741
parentf72153f6e555ecd507975984cb2e149a90d639e9 (diff)
downloadorg.eclipse.linuxtools-c982d2b3399f183791f6ccb52face97878d03454.tar.gz
org.eclipse.linuxtools-c982d2b3399f183791f6ccb52face97878d03454.tar.xz
org.eclipse.linuxtools-c982d2b3399f183791f6ccb52face97878d03454.zip
Systemtap: Updating the documentation with the wiki
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html6
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html36
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html24
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html38
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml16
5 files changed, 68 insertions, 52 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html
index e232f88266..87912db408 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html
@@ -322,9 +322,9 @@
<a href="SystemTap-IDE.html#Preferences">Preferences </a>
</li>
</ul>
- <h3 id="Toolbars_2">Toolbars</h3>
+ <h3 id="Toolbars_3">Toolbars</h3>
<p>SystemTap GUI currently has two toolbars built in; an Action Bar for file and execution operations and a Perspective Selector to jump to different perspectives.</p>
- <h4 id="Action_Bar_2">Action Bar</h4>
+ <h4 id="Action_Bar_3">Action Bar</h4>
<ul>
<li>
<img border="0" src="images/Import_wiz.gif"/>
@@ -352,7 +352,7 @@
<a href="http://wiki.eclipse.org/Linux_Tools_Project/Systemtap/User_Guide/dashboard/modulesBrowser.html" title="Linux_Tools_Project/Systemtap/User_Guide/dashboard/modulesBrowser.html">Modules Browser </a>.
</li>
</ul>
- <h4 id="Perspective_Selector_2">Perspective Selector</h4>
+ <h4 id="Perspective_Selector_3">Perspective Selector</h4>
<ul>
<li>
<img border="0" src="images/Ide.png"/>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html
index 23cf99a2bb..addb060b7a 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html
@@ -425,6 +425,42 @@ probe timer.ms(1000) {
<a href="SystemTap-IDE.html#Preferences">Preferences </a>.
<img border="0" src="images/Preferencesbox1.png"/>
</li>
+ </ul>
+ <h3 id="Toolbars_2">Toolbars</h3>
+ <p>SystemTap GUI currently has two toolbars built in; an Action Bar for file and execution operations and a Perspective Selector to jump to different perspectives.</p>
+ <h4 id="Action_Bar_2">Action Bar</h4>
+ <ul>
+ <li>
+ <img border="0" src="images/Open_wiz.gif"/>
+ <b>Open Script Output</b> - This option opens the specified file and reads the contents into the DataTable for use in the Graphing Perspective.
+ </li>
+ <li>
+ <img border="0" src="images/Save_wiz.gif"/>
+ <b>Save Graph Image</b> - This option saves the graph in the specified file extension format.
+ </li>
+ <li>
+ <img border="0" src="images/Import_wiz.gif"/>
+ <b>Import Data Set</b> - This option allows you to load a previously saved set of data obtained from running a SystemTap script. You can proceed from this point as if you had just ran a script and populated the DataTable.
+ </li>
+ <li>
+ <img border="0" src="images/Export_wiz.gif"/>
+ <b>Export Data Set</b> - This option allows you to save a current data set after you've ran a script in the intention of having someone else look at the user's script results through the tool or for further work done by the user.
+ </li>
+ <li>
+ <img border="0" src="images/Stop_obj.gif"/>
+ <b>Stop Script</b> - This button will stop the currently active script from running.
+ </li>
+ </ul>
+ <h4 id="Perspective_Selector_2">Perspective Selector</h4>
+ <ul>
+ <li>
+ <img border="0" src="images/Ide.png"/>
+ <b>IDE Perspective</b> - This button brings you into the IDE Perspective, useful for writing and executing scripts.
+ </li>
+ <li>
+ <img border="0" src="images/Graphing.png"/>
+ <b>Graphing Perspective</b> - This button brings you into the Graphing Perspective, useful for graphing scripts.
+ </li>
</ul><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html
index b769e01a96..fdbcb98824 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html
@@ -36,7 +36,7 @@
<p>In this tutorial we will orient you with IDE Perspective and its functions. At this point we assume
that you are able to run Systemtap GUI and are unfamiliar with how to procede. If you cannot yet start
the application, please refer to our
- <a href="User-Guide.html#Installation">Installation help page</a>
+ <a href="#Installation">Installation help page</a>
<b>NOTE:</b> If this is the first time opening the IDE Perspective it will take a while to load as it has to
parse the tapsets.
@@ -86,7 +86,7 @@
</pre>
<p> </p>
<p>Now to demonstrate the functionality of the Probe Alias browser we will have you complete the read probe yourself. Start by opening the syscall folder in the Probe Alias browser. If you do not have any content in the browser you are experiencing a problem with Systemtap installation and should refer to our
- <a href="User-Guide.html#Installation">Installation help page</a>. Ensure your cursor is located at the end of the file. Now scroll down and double click the read probe alias. Systemtap GUI will insert the skeleton probe at the point at which your cursor is at, and should look similar to the following:
+ <a href="#Installation">Installation help page</a>. Ensure your cursor is located at the end of the file. Now scroll down and double click the read probe alias. Systemtap GUI will insert the skeleton probe at the point at which your cursor is at, and should look similar to the following:
</p>
<pre>probe syscall.read
{
@@ -730,7 +730,9 @@
<p>There is also a description of the examples -
<a href="http://sourceware.org/systemtap/examples/demo_script.txt">http://sourceware.org/systemtap/examples/demo_script.txt</a>
</p>
- <h4 id="top.stp_-_Prints_the_top_20_system_calls_.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Ftop.stp.29">top.stp - Prints the top 20 system calls (http://sourceware.org/systemtap/examples/top.stp)</h4>
+ <h4 id="top.stp_-_Prints_the_top_20_system_calls_.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Ftop.stp.29">top.stp - Prints the top 20 system calls (
+ <a href="http://sourceware.org/systemtap/examples/top.stp">http://sourceware.org/systemtap/examples/top.stp</a>)
+ </h4>
<pre>
#!/usr/bin/env stap
#
@@ -759,7 +761,9 @@ probe kernel.function("sys_*") {
probe timer.ms(5000) {
print_top ()
</pre>
- <h4 id="prof.stp_-_Simple_profiling_.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fprof.stp.29">prof.stp - Simple profiling (http://sourceware.org/systemtap/examples/prof.stp)</h4>
+ <h4 id="prof.stp_-_Simple_profiling_.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fprof.stp.29">prof.stp - Simple profiling (
+ <a href="http://sourceware.org/systemtap/examples/prof.stp">http://sourceware.org/systemtap/examples/prof.stp</a>)
+ </h4>
<pre>
#!/usr/bin/env stap
@@ -797,7 +801,9 @@ probe end {
global calltime, ttime
</pre>
- <h4 id="keyhack.stp_-_Modifying_variables_in_the_kernel._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkeyhack.stp.29">keyhack.stp - Modifying variables in the kernel. (http://sourceware.org/systemtap/examples/keyhack.stp)</h4>
+ <h4 id="keyhack.stp_-_Modifying_variables_in_the_kernel._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkeyhack.stp.29">keyhack.stp - Modifying variables in the kernel. (
+ <a href="http://sourceware.org/systemtap/examples/keyhack.stp">http://sourceware.org/systemtap/examples/keyhack.stp</a>)
+ </h4>
<pre>
#! /usr/bin/env stap
@@ -815,7 +821,9 @@ probe end {
printf("\nDONE\n")
}
</pre>
- <h4 id="kmalloc.stp_-_Statistics_example._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkmalloc.stp.29">kmalloc.stp - Statistics example. (http://sourceware.org/systemtap/examples/kmalloc.stp)</h4>
+ <h4 id="kmalloc.stp_-_Statistics_example._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkmalloc.stp.29">kmalloc.stp - Statistics example. (
+ <a href="http://sourceware.org/systemtap/examples/kmalloc.stp">http://sourceware.org/systemtap/examples/kmalloc.stp</a>)
+ </h4>
<pre>
#! /usr/bin/env stap
@@ -840,7 +848,9 @@ probe end {
print(@hist_log(kmalloc))
}
</pre>
- <h4 id="kmalloc2.stp_-_Example_using_arrays_of_statistics._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkmalloc2.stp.29">kmalloc2.stp - Example using arrays of statistics. (http://sourceware.org/systemtap/examples/kmalloc2.stp)</h4>
+ <h4 id="kmalloc2.stp_-_Example_using_arrays_of_statistics._.28http:.2F.2Fsourceware.org.2Fsystemtap.2Fexamples.2Fkmalloc2.stp.29">kmalloc2.stp - Example using arrays of statistics. (
+ <a href="http://sourceware.org/systemtap/examples/kmalloc2.stp">http://sourceware.org/systemtap/examples/kmalloc2.stp</a>)
+ </h4>
<pre>
#! /usr/bin/env stap
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html
index 0d44da58d4..224d41f132 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html
@@ -26,7 +26,7 @@
</tr>
</table><hr/>
<h1 id="Overview">Overview</h1>
- <p>Welcome to the SystemTapGUI Help pages. This section is intended to provide users with information and links about the SystemTap scripting language itself, in addition to a brief introduction to SystemTap GUI's structure for new users and a brief explanation of SystemTap.</p>
+ <p>Welcome to the SystemTap GUI Help pages. This section is intended to provide users with information and links about the SystemTap scripting language itself, in addition to a brief introduction to SystemTap GUI's structure for new users and a brief explanation of SystemTap.</p>
<h2 id="SystemTap_GUI.27s_Plugin_Design">SystemTap GUI's Plugin Design</h2>
<p>SystemTap GUI was built with a modular goal in mind, namely, to provide the application as a series of plugins so that users may obtain just the ones they need without having to use a heavy-weight application should if they didn't need to. The most common example of this is to ship the Dashboard plugin independently, allowing non-SystemTap savvy users the ability to execute modules without having to write any scripts. The application in its complete state includes three perspective, each with a specific goal:</p>
<ul>
@@ -46,11 +46,9 @@
<p>SystemTap provides a simple command line interface and scripting language for writing instrumentation for a live running kernel. The internal tapset library as well as the published samples can be used to aid reuse and abstraction.</p>
<p>Current project members include Red Hat, IBM, Intel, and Hitachi.</p>
<h2 id="Configuration_Tutorial">Configuration Tutorial</h2>
- <p>This tutorial is written to guide a new SystemTap GUI user through some basic post-installation setup in
+ <p>This tutorial is written to guide a new SystemTap user through some basic post-installation setup in
order to get the most out of the application.</p>
- <h3 id="Installation">Installation</h3>
- <p>This section details the steps required for the installation of Systemtap GUI on the user's machine.</p>
- <h4 id="Requirements">Requirements</h4>
+ <h3 id="Requirements">Requirements</h3>
<p>
<b>Hardware Requirements:</b>
</p>
@@ -69,37 +67,9 @@
</ul>
</li>
</ul>
- <p>The Gui is a client-server application and the server and client can be installed seperately. The client is an eclipse plugin and requires eclipse to be installed. It provides an IDE to write scripts and a visualizer to view the output in graphical form.</p>
- <pre>The server (stapgui-server) provides stdout/stderr data collection and process management services for processes run on a remote system. The server executes the SystemTap script, collects all output to stderr and stdout from that process, then funnels it via a socket to the client.
-</pre>
- <p>The client and server can be installed on machines with different architectures.This allows users to monitor remote machines. You may also download and build the source yourself.</p>
- <p>
- <b>NOTE: The client and server are seperate packages and need to be installed independently.</b> You are viewing this help on the eclipse based client.
- </p>
- <p>NOTE: Installation assumes you already have both Eclipse and SystemTap installed.</p>
- <h4 id="Server">Server</h4>
- <ul>
- <li>Install the systemtapguiserver rpm.</li>
- </ul>
- <pre> Eg on Fedora run the command:
- yum install systemtapguiserver
-</pre>
- <ul>
- <li>Run the command 'stapgui-server'. You will get a message saying "Listening for Connections..." in a minute or so which shows that the server is up and running.</li>
- </ul>
- <h4 id="Client">Client</h4>
- <ul>
- <li>Install the eclipse-systemtapgui rpm.</li>
- </ul>
- <pre> Eg on Fedora run the command:
- yum install eclipse-systemtapgui
-</pre>
- <ul>
- <li>Launch eclipse and open the SystemTap IDE perspective to start writing scripts.</li>
- </ul>
<h3 id="Kernel_Source_Location">Kernel Source Location</h3>
<p>In order to use the kernel source browser you'll need to point it to the kernel source initially. Do this by either selecting the Kernel Source Browser in the browser pane or by going to
- <b><u>W</u>indow-&gt;<u>P</u>references</b>, then going to the SystemTap-&gt;IDE-&gt;Path tab and setting the location there. This configuration detail is relevent to the IDE Perspective only.
+ <b><u>W</u>indow-&gt;<u>P</u>references</b>, then going to the SystemTap-&gt;IDE-&gt;'Kernel Source Path' tab and setting the location there. This configuration detail is relevent to the IDE Perspective only.
</p>
<h3 id="Tutorials">Tutorials</h3>
<p>If you haven't already, you will want to take the IDE and Graphing tutorials. You can find them in the Getting Started section of each perspective's help pages. These tutorial provides fundamental knowledge on graphing in SystemTap GUI.</p>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml
index d51db39537..73ac5cdb1c 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml
@@ -5,11 +5,7 @@
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#SystemTap_GUI.27s_Plugin_Design" label="SystemTap GUI's Plugin Design"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Systemtap" label="Systemtap"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Configuration_Tutorial" label="Configuration Tutorial">
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Installation" label="Installation">
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Requirements" label="Requirements"></topic>
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Server" label="Server"></topic>
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Client" label="Client"></topic>
- </topic>
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Requirements" label="Requirements"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Kernel_Source_Location" label="Kernel Source Location"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Tutorials" label="Tutorials"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/User-Guide.html#Preferences_.28Optional.29" label="Preferences (Optional)"></topic>
@@ -98,6 +94,10 @@
<topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Run_2" label="Run"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Window_2" label="Window"></topic>
</topic>
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Toolbars_2" label="Toolbars">
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Action_Bar_2" label="Action Bar"></topic>
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Perspective_Selector_2" label="Perspective Selector"></topic>
+ </topic>
</topic>
</topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html" label="SystemTap Dashboard">
@@ -132,9 +132,9 @@
<topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Run_3" label="Run"></topic>
<topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Window_3" label="Window"></topic>
</topic>
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Toolbars_2" label="Toolbars">
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Action_Bar_2" label="Action Bar"></topic>
- <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Perspective_Selector_2" label="Perspective Selector"></topic>
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Toolbars_3" label="Toolbars">
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Action_Bar_3" label="Action Bar"></topic>
+ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Perspective_Selector_3" label="Perspective Selector"></topic>
</topic>
</topic>
</topic>

Back to the top