diff options
| author | Andrew Ferrazzutti | 2013-12-09 22:40:06 +0000 |
|---|---|---|
| committer | Andrew Ferrazzutti | 2013-12-09 22:46:36 +0000 |
| commit | b7427bd08946054c8a114494844e4db5d135b8dc (patch) | |
| tree | d5548f9510dd9146440fed86d4afb6235b498852 | |
| parent | 3bee93f9e2b6992bde8b5c215b013929ee60c3fb (diff) | |
| download | org.eclipse.linuxtools-b7427bd08946054c8a114494844e4db5d135b8dc.tar.gz org.eclipse.linuxtools-b7427bd08946054c8a114494844e4db5d135b8dc.tar.xz org.eclipse.linuxtools-b7427bd08946054c8a114494844e4db5d135b8dc.zip | |
Systemtap: update help doc.
Change-Id: I314481dc11bed41908c7cdb19f49ba1da2b684f3
Signed-off-by: Andrew Ferrazzutti <aferrazz@redhat.com>
Reviewed-on: https://git.eclipse.org/r/19541
22 files changed, 381 insertions, 489 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Copyright-Information.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Copyright-Information.html new file mode 100644 index 0000000000..9cd88b6db8 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Copyright-Information.html @@ -0,0 +1,67 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>SystemTap User Guide - Copyright Information</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Copyright Information</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="SystemTap-Graphing.html" title="SystemTap Graphing"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">SystemTap Graphing</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Copyright_Information">Copyright Information</h1> + <p><p class="copyright"> +© Copyright IBM Corporation 2012 + <br/> +© Copyright Red Hat, Inc. 2009 + <br/> +© Copyright Phil Muldoon <pkmuldoon@picobot.org> 2006. + <br/> + This documentation is licensed under the Eclipse Public License v. 1.0.</p> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="SystemTap-Graphing.html" title="SystemTap Graphing"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="SystemTap User Guide"> + <img alt="SystemTap User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">SystemTap Graphing</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file 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 ba8a3af89e..69fe051be2 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 @@ -18,7 +18,7 @@ </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> - <a href="SystemTap-Dashboard.html" title="SystemTap Dashboard"> + <a href="Copyright-Information.html" title="Copyright Information"> <img alt="Next" border="0" src="../../../images/next.gif"/> </a> </td> @@ -26,102 +26,108 @@ <tr> <td style="width: 20%" align="left" valign="top">SystemTap IDE</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">SystemTap Dashboard</td> + <td style="width: 20%" align="right" valign="top">Copyright Information</td> </tr> </table><hr/> <h1 id="SystemTap_Graphing">SystemTap Graphing</h1> <h2 id="Getting_Started_2">Getting Started</h2> <h3 id="Introduction">Introduction</h3> - <p>The Graphing Perspective in the SystemTap Plug-in is a perspective that is active once a user runs a script with the chart option ( - <b><u>R</u>un->Run w/ <u>C</u>hart</b>). From this point a - <a href="SystemTap-Graphing.html#DataTable">DataTable </a> is populated with live data as it is parsed from the Console. From the information in the DataTable you can generate the following graphs: + <p>TWhen a SystemTap script is launched under a Run Configuration with the + <b>Graph the output of this script run</b> option enabled, it is possible to plot its output in graph form. (If you are unfamiliar with how to load or write a SystemTap script, please review the + <a href="SystemTap-IDE.html#IDE_Tutorial">IDE Tutorial</a> in the SystemTap IDE User's Guide.) A variety of graph types are available for plotting the output of Systemtap scripts: </p> <ul> <li> - <a href="SystemTap-Graphing.html#Scatter_Graph">Scatter Graph </a> + <a href="#Scatter_Graph">Scatter Graph</a> </li> <li> - <a href="SystemTap-Graphing.html#Line_Graph">Line Graph </a> + <a href="#Line_Graph">Line Graph</a> </li> <li> - <a href="SystemTap-Graphing.html#Area_Graph">Area Graph </a> + <a href="#Area_Graph">Area Graph</a> </li> <li> - <a href="SystemTap-Graphing.html#Bar_Graph">Bar Graph </a> + <a href="#Bar_Graph">Bar Graph</a> </li> <li> - <a href="SystemTap-Graphing.html#Pie_Graph">Pie Graph </a> + <a href="#Pie_Graph">Pie Graph</a> </li> </ul> - <p>These graph types can be used instantiated by using the Graph Wizard once the DataTable is populated. The Graphing Perspective can support multiple graphs from one DataTable. Each are updated and can be viewed by navigating through the tabs shown at the top of each graph.</p> - <p>If you have not already, you will want to review the - <a href="SystemTap-Graphing.html#Graphing_Tutorial">Graphing Tutorial </a> + <p>These graph types can be instantiated as soon as a script is run by creating them in a script's Run Configuration, or after a script run has been initiated by using the + <img border="0" src="images/New_wiz.gif"/> + <a href="#Create_Graph_Wizard">Create Graph</a> wizard in the Graph Selector View. Please refer to + <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a> for information on how to use Run Configurations and regular expressions to capture data from a script's output, and how to plot that data in graphs. </p> <h3 id="Graphing_Tutorial">Graphing Tutorial</h3> - <p>In order to graph SystemTap scripts you must have a script open in the IDE Perspective, and the - <b><u>R</u>un->Run w/ Chart</b> option must be used. If you are unfamiliar with how to load or write a SystemTap script, please review the IDE Tutorial in the SystemTap IDE User's Guide. Please use the following script for this example by copying and pasting it into a new file (any name is fine that ends in a .stp extension): + <p>This tutorial picks up from where + <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a> left off, and provides more information on graph configuration. If you followed that tutorial already, click + <b>Run As -> Run Configurations...</b> and view the configuration you created earlier. If not, follow that tutorial now, and return here when you have finished. </p> - <pre>global read, write, start - -probe begin { - start = gettimeofday_s() -} -probe syscall.write { - write += count -} - -probe syscall.read { - read += count -} - -probe timer.ms(1000) { - printf("%d\t%d\t%d\n", (gettimeofday_s()-start), read, write) - read=0 - write=0 -} -</pre> - <p> </p> - <p>Now select - <b><u>R</u>un->Run w/ <u>C</u>hart</b>. This feature will prompt the user for the number of columns for the chart, in addition to their titles and regular expressions. The regular expressions are used to parse the console output for the script and determine the values of each column at a certain sample point. The combined regular expression is shown at the bottom of the dialogue box. You should see the following: + <p>Once the Run Configuration menu is opened with your configuration selected, click on the + <b>Graphing</b> tab. At the bottom of the window, a section labelled + <b>Graph Set #</b> displays a list of all graphs created for the currently-selected + <b>Regular Expression</b> (the # in "Graph Set #" indicates which expression is chosen). There is also a set of buttons related to graph configuration: </p> + <ul> + <li> + <b>Add...</b> - Brings up the + <a href="#Create_Graph_Wizard">Create Graph</a> wizard to allow you to create a new graph. + </li> + <li> + <b>Duplicate</b> - When one of the graphs in the list of entries is selected (by clicking on it), this button creates a duplicate of that graph. + </li> + <li> + <b>Edit...</b> - When one of the graphs in the list of entries is selected, this button allows you to edit the settings of that graph with the + <a href="#Create_Graph_Wizard">Edit Graph</a> wizard. + </li> + <li> + <b>Remove</b> - Removes the currently selected graph. + </li> + </ul> <p> - <img border="0" src="images/Chartbox1.png"/> - </p> - <p>For this example enter the following: </p> - <pre> Columns: 3 - - TITLE REGULAR EXPRESSION DELIMITER - Time \d+ .* \D+ - Read \d+ .* \D+ - Write \d+ .* \D+ -</pre> - <p> - The title fields simply display the associated string in the column's header. After clicking OK the script will prompt you for details regarding the Remote Server. Provide the ip address of the remote server that is running the systemtapgui Server or the Data Management Daemon. The port is by default 22462. Enter a username and password.This will give the application permissions to run your script on the remote machine. You have the option of saving your password as well, however be warned this is currently NOT encrypted so this convenience runs at a risk. The username is also used to transfer the file to the remote system using SCP. If the same machine is used as both the server and the client enter 'localhost' for the Host field. When the script is executed the application will switch into the Graphing perspective. A Data View chart is populated with live data, in addition to the output in the console. You should see a screen similar to the following:</p> - <p> - <img border="0" src="images/IDEGraphics.png"/> - </p> - <p>You will see that the data table poplulates from live data parsed from the console. Now we'll make a graph to briefly illustrate the Graphing perspective. Click the Create Graph button next to bring up the Select Chart dialogue. </p> - <p> - <img border="0" src="images/GraphWizard.png"/> + <b>Note:</b> Each regular expression you create has its own Graph Set. When creating & editing graphs, the only graphs that will be visible in the + <b>Graph Set #</b> section will be the graphs used for the expression currently selected in the + <b>Regular Expression</b> combo box. </p> - <p>Select line graph. You will be prompted to select a column of the X series and Y series; select "Time" and "Write" respectively. After you click ok you should see the line graph as follows: </p> - <p> - <img border="0" src="images/IDEGraph.png"/> + <h4 id="Create_Graph_Wizard">Create Graph Wizard</h4> + <p>The + <b>Create Graph</b> (or + <b>Edit Graph</b> Wizard is used when creating a new graph or editing an existing one. It allows you to set all properties of a graph, such as its title, graph type, and series data. </p> - <p>Note that the multiple series graphs (Multi-Line, Multi-Bar, and Multi-Scatter) will request two Y series, Y1 and Y2. In the case of our example, these would be "Read" and "Write". Each series will be assigned a different color value for the purposes of differentiation and will be plotted both in respect to the specified X series.</p> + <ul> + <li> + <b>Graph Type</b> - The type of graph to draw. See + <a href="#Data_Graph_Types">Graph Types</a> for the list of graph types available, and an explanation of each. + </li> + <li> + <b>Title</b> - The title the graph will have when displayed in the Graph Selector View. + </li> + <li> + <b>X Series</b> - The class of data that will provide the graph's X series data. This data can come from one of the capturing groups of your regular expression (which appear as their user-defined titles), or, if set to + <b>Row Num</b>, the graph will plot a new data point for every line/row of output that is matched by your regular expression. + </li> + <li> + <b>Y Series 0</b> - The class of data that will provide the graph's Y series data, relative to the X axis. A capturing group from your regular expression must be used for this. + </li> + <li> + <b>Y Series 1, 2, 3</b>... - If you have included more than one capturing group in your regular expression, you may choose to provide your graph with multiple Y series data, each of which will be plotted relative to the same X series axis you specified earlier. They will appear as a seperate set of data points on your graph, labelled by title. When you do not want to include any extra Y series values, choose + <b>NA</b>. + </li> + </ul> + <p>Note that two different series may not share the same data selection.</p> <h2 id="Concepts_2">Concepts</h2> - <h3 id="DataTable">DataTable</h3> - <p>The DataTable is the default view the user sees when running a script with the chart option. It intitially starts empty and populates as it recieves information parsed from the console originally from the script. The DataTable is a visualization of the data structure that every other graph type spawns from. - - <img border="0" src="images/GraphingPerspective.png"/> + <h3 id="Data_Table">Data Table</h3> + <p>The Data Table is a view that is always available when running a script with the chart option. It intitially starts empty and populates as it recieves information parsed from the console originally from the script. The Data Table is a visualization of the data structure that every other graph type spawns from.</p> + <p> + <img border="0" src="images/SystemtapGraphDataView.png"/> </p> - <p>The columns of the DataTable can be resized at will by dragging the seperation lines between column headers. In addition, the information in the data table can be - <a href="SystemTap-Graphing.html#Importing_a_Data_Set">saved and loaded </a> without having to re-run the script. Furthermore, the user can populate the DataTable without having to run a script if a script's output has been saved into a file, see - <a href="SystemTap-Graphing.html#Opening_Script_Output">Opening Script Output </a>.Right clicking the DataTable provides a menu with the following options: + <p>The columns of the Data Table can be resized at will by dragging the seperation lines between column headers. In addition, the information in the data table can be + <a href="#Importing_a_Data_Set">saved and loaded</a> without having to re-run the script. Furthermore, the user can populate the Data Table without having to run a script if a script's output has been saved into a file, see + <a href="#Opening_Script_Output">Opening Script Output</a>.Right clicking the Data Table provides a menu with the following options: </p> <ul> <li> - <b>Format as...</b> - Depending on which column the user right clicked, his allows the user to format that column's data as one of the following: + <b>Format as...</b> - Depending on which column the user right clicked, this allows the user to format that column's data as one of the following: <ul> <li>Unformated - No formating is applied. </li> <li>String </li> @@ -134,19 +140,21 @@ probe timer.ms(1000) { </li> <li> <b>Add Filter...</b> - Adds a - <a href="SystemTap-Graphing.html#Filters">filter </a> to the DataTable. + <a href="#Filters">filter</a> to the Data Table. </li> <li> <b>Remove Filter...</b> - Removes a - <a href="SystemTap-Graphing.html#Filters">filter </a> from the DataTable. + <a href="#Filters">filter</a> from the Data Table. </li> <li> <b>Manually Resize</b> - Allows the user to resize column width without bouncing back to the minimum based on the largest value. </li> </ul> - <h3 id="DataGraph_Types">DataGraph Types</h3> + <h3 id="Data_Graph_Types">Data Graph Types</h3> <p>Currently there are five graph types built into SystemTap Plug-in.</p> - <p>These graph types can be used instantiated by using the Graph Wizard once the DataTable is populated. The Graphing Perspective can support multiple graphs from one DataTable. Each are updated and can be viewed by navigating through the tabs shown at the top of each graph.</p> + <p>These graph types can be used instantiated by using the + <a href="#Create_Graph_Wizard">Create Graph</a> wizard once the Data Table is populated. The Graphing Perspective can support multiple graphs from one Data Table. Each are updated and can be viewed by navigating through the tabs shown at the top of each Graph Set while in the Graph Selector View. + </p> <h4 id="Scatter_Graph">Scatter Graph</h4> <p>A Scatter Graph uses Cartesian coordinates to show the relation of two or more quantitative variables.</p> <p>Creating a Scatter Graph will prompt the user for three values. The first is the title and is fully cosmetic. The option to turn on and off the title is given to the user, and its off by default. The second option is X Series; here you select which series of data you want to plot along the X Axis. The third option is the Y Series; here you select which series of data you want to plot along the Y Axis. @@ -177,26 +185,26 @@ probe timer.ms(1000) { </p> <h4 id="Pie_Graph">Pie Graph</h4> <p>The Pie Graph uses a pie to show percentages.</p> - <p>Creating a Pie Graph will prompt the user for three values. The first is the title and is fully cosmetic. The option to turn on and off the title is given to the user, and its off by default. The second option is X Series; here you select the series to be used as labels of each area of the pie chart. The third option is the Y Series; here you select which series of data will be used to calculate the percentages of each area of the pie chart. Optionally you can add extra Y Series; here you select another series of data you want to plot along the Y Axis.</p> + <p>Creating a Pie Graph will prompt the user for three values. The first is the title and is fully cosmetic. The option to turn on and off the title is given to the user, and its off by default. The second option is X Series; here you select the series to be used as labels of each area of the pie chart. The third option is the Y Series; here you select which series of data will be used to calculate the percentages of each area of the pie chart. Optionally you can add extra Y Series, each of which will draw another Pie containing that series' data.</p> <p> <img border="0" src="images/Pie.png"/> </p> <h3 id="Filters">Filters</h3> - <p>Filters are screens that you can set on your DataTable to limit the quantity of samples you wish to work with. Filters are very often used in restricting the sheer amount of information available to make data tables and graphs more substantial to people.</p> - <p>The following options exist to work with Filters in the DataTable:</p> + <p>Filters are screens that you can set on your Data Table to limit the quantity of samples you wish to work with. Filters are very often used in restricting the sheer amount of information available to make data tables and graphs more substantial to people.</p> + <p>The following options exist to work with Filters in the Data Table:</p> <ul> <li> - <b>Add Filter...</b> - Adds a Filter to the DataTable. + <b>Add Filter...</b> - Adds a Filter to the Data Table. </li> <li> - <b>Remove Filter...</b> - Removes a Filter from the DataTable. + <b>Remove Filter...</b> - Removes a Filter from the Data Table. </li> </ul> <p>When you select <b>Add Filter</b> you see the following dialogue box: </p> <p> - <img border="0" src="images/Filters.png"/> + <img border="0" src="images/StapDataFilters.png"/> </p> <p>What follows is a breakdown of each Filter type:</p> <ul> @@ -207,8 +215,9 @@ probe timer.ms(1000) { <p>value does not match the chosen value.</p> <p> <img border="0" src="images/Match.png"/> - Result: - + </p> + <p>Result:</p> + <p> <img border="0" src="images/Match2.png"/> </p> <ul> @@ -232,8 +241,9 @@ probe timer.ms(1000) { <p>removed.</p> <p> <img border="0" src="images/Sort.png"/> - Result: - + </p> + <p>Result:</p> + <p> <img border="0" src="images/Sort2.png"/> </p> <ul> @@ -242,8 +252,8 @@ probe timer.ms(1000) { </li> </ul> <p>value in the selected column. Data for the removed rows will be aggregated together based on the chosen - aggregation method. - + aggregation method.</p> + <p> <img border="0" src="images/Unique.png"/> </p> <ul> @@ -269,194 +279,44 @@ probe timer.ms(1000) { </ul> <h3 id="Graph_Interaction">Graph Interaction</h3> <p>Each of the - <a href="SystemTap-Graphing.html#DataGraph_Types">Graph Types </a> have similar options that can be used in the Graphical + <a href="#Data_Graph_Types">Graph Types</a> have similar options that can be used in the Graphical Perspective: </p> <ul> <li> - <b>Zoom Bar</b> - This enables the user to zoom in and out on the current graph by sliding the bar up and down. The current magnification is shown at the top of the bar. Magnification can range from as high as .0625x to as low as 4x the dimensions of the original graph.< - <img border="0" src="images/Zoom.png"/> - </li> - <li> - <b>Title</b> - This option turns on and off the title specified in the graph creation wizard. - </li> - <li> - <b>Legend</b> - This option turns on and off the legend, particularly useful in the graph types that show multiple series. - </li> - <li> - <b>Grid Lines</b> - This option permits the user to turn and off the grid lines. - </li> - <li> - <b>Normalization</b> - The option to normalize occurs only in multi-series graphs. By default, series graphs are rendered using normalization which scales them to visuals easily comparable to one another. The user has the option to view the normalization scale by clicking the data in the graph. The user also has the option of disabling normalization by deselecting it. + <b>Zoom Bar</b> - The graph types that use axes (Scatter, Line, Area, and Bar graphs) support this control. This enables the user to reduce the number of X-axis values that are plotted on the graph, to effectively zoom in and out on the graph's display. Sliding the bar left reduces the range of the X-axis that is plotted (zoom in), and sliding right increases it (zoom out). </li> </ul> <p> - <img border="0" src="images/GraphExpanded.png"/> - </p> - <h2 id="Tasks_2">Tasks</h2> - <p>This section of the Graphing User Guild is intended to provide help pages for common tasks that the user may wish to perform in the Graphics Perspective.</p> - <h3 id="Importing.2FExporting_Data_Sets">Importing/Exporting Data Sets</h3> - <p>From time to time the user may want to preserve the script results for continued work at a later date/time or to share findings with others. The Importing and Exporting options provide an easy way to do this.</p> - <h4 id="Importing_a_Data_Set">Importing a Data Set</h4> - <p>In order to import a Data Set the user must first have one either from running a script or from another user. To import the Data Set select - <b><u>F</u>ile-><u>I</u>mport Data Set</b>. The user will be prompted with an Open File dialogue box. Navigate to the Data Set file you wish to open and select it. Keep in mind Data Set files can have any extension type, though the user may want to use .set for consistency. - - <img border="0" src="images/Import.png"/> - </p> - <h4 id="Exporting_a_Data_Set">Exporting a Data Set</h4> - <p>In order to export a Data Set the user must first have a populated DataTable from a previously running script. To export the Data Set select - <b><u>F</u>ile-><u>E</u>xport Data Set</b>. The user will be prompted with an New File dialogue box. Navigate to the location you wish to export the Data Set to and save it. Keep in mind Data Set files can have any extension type, though the user may want to use .set for consistency. - - <img border="0" src="images/Export.png"/> + <img border="0" src="images/ZoomX.png"/> </p> - <h3 id="Generating_Graphs">Generating Graphs</h3> - <p>In order to graph SystemTap scripts you must have a script open in the IDE Perspective, and the - <b><u>R</u>un->Run w/ Chart</b> option must be used. If you are unfamiliar with how to load or write a SystemTap script, please review the IDE Tutorial in the SystemTap IDE User's Guide. - </p> - <p>A - <a href="SystemTap-Graphing.html#Graphing_Tutorial">Graphing Tutorial </a> has been written to guide the user through the execution and charting of a provided script. Any script can be used however that provides consistent data along with a regular expression (regex). For instructions on using regex see our - <a href="SystemTap-IDE.html#Guide_to_Regular_Expressions">Guide to Regular Expressions </a>. - </p> - <h3 id="Opening_Script_Output">Opening Script Output</h3> - <p>This option allows the user to open a text file containing the output of a SystemTap script, and to parse it as it would real time data from a running script. Select - <b><u>F</u>ile-><u>O</u>pen Script Output</b>. Navigate to the file you wish to open and select it. The DataTable will populate with the data, at which point you can graph the results. - </p> - <h3 id="Saving_a_Graph_Image">Saving a Graph Image</h3> - <p>The Graphics Perspective provides a unique feature to users that allows them to save their graphs in a standard image format. In order to do this use the menu option - <b><u>F</u>ile->Save <u>G</u>raph Image</b>. This opens a dialogue box where the user can navigate to the location they desire to save the image file. - </p> - <p> - <img border="0" src="images/Saveoutput.png"/> + <p>Use + <a href="SystemTap-IDE.html#Preferences">Preferences</a> to configure other graph settings, such as grid lines and viewable data items. </p> <h2 id="Reference_2">Reference</h2> - <p>This section of the Graphing User Guild is intended to provide the following resources should you have any - very specific questions regarding the Graphing Perspective in general or one of the options associated with + <p>This section of the Graphing User Guide is intended to provide the following resources should you have any + very specific questions regarding the graphing in general or one of the options associated with it. It also contains example scripts and FAQs.</p> <h3 id="Frequently_Asked_Questions_2">Frequently Asked Questions</h3> - <p>This section details frequently asked questions relating to the Graphing Perspective.</p> + <p>This section details frequently asked questions relating to graphing script output.</p> <p> <b>Can I make more than one graph at one time? Do they update concurrently?</b> </p> - <p>A: Yes and yes. Start another graph the same way you started the first one, by clicking the Graph Wizard button.</p> + <p>A: Yes and yes. In the Run Configuration of the script you want to create plots of, you can create multiple graphs at once. Also, after a graph-enabled script is run, you may create several additional graphs by clicking the Graph Wizard button in the Graph Selector View.</p> <p> <b>Can I increase the rate at which SystemTap GUI update the graph?</b> </p> - <p>A: Yes. By default it is set to once per second, but you can increase this in the - <a href="SystemTap-IDE.html#Preferences">Preferences </a> + <p>A: Yes. By default it is set to once per second, but you can increase this in + <a href="SystemTap-IDE.html#Preferences">Preferences</a>. </p> <p> <b>Is there any way to save or export the graph images?</b> </p> - <p>A: Yes. Use - <b><u>F</u>ile->Save <u>G</u>raph Image</b> to save the graph. - </p> + <p>A: Currently, no. This feature will be restored in a newer version of Systemtap IDE.</p> <p> <b>What if I want to preserve this data for manipulation later?</b> </p> - <p>A: You can do this by using - <b><u>F</u>ile-><u>E</u>xport Data Set</b>. This will save your data set for further - work. - </p> - <h3 id="Menus_2">Menus</h3> - <p>What follows is a comprehension list of the menu options available within the Systemtap GUI Graphing Perspective.</p> - <h4 id="File">File</h4> - <ul> - <li> - <b><u>O</u>pen Script Output</b> - This option opens the specified file and reads the contents into the DataTable for use in the Graphing Perspective. - <img border="0" src="images/Openbox1.png"/> - </li> - <li> - <b>Save <u>G</u>raph Image</b> - This option saves the graph in the specified file extension format. - <img border="0" src="images/Saveoutput.png"/> - </li> - <li> - <b><u>I</u>mport 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. - <img border="0" src="images/Import.png"/> - </li> - <li> - <b><u>E</u>xport 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. (Shortcut: Ctrl+X) - <img border="0" src="images/Export.png"/> - </li> - <li> - <b><u>P</u>rint</b> - This option prints the graph currently holding the focus. (Shortcut: Crtl+P) - </li> - <li> - <b>E<u>x</u>it</b> - Exits Systemtap GUI. - </li> - </ul> - <h4 id="Run_2">Run</h4> - <ul> - <li> - <b><u>S</u>top</b> - This option terminates the script thread associated with whichever script currently has the focus. (Shortcut: Ctrl+F9) - </li> - </ul> - <h4 id="Window_2">Window</h4> - <ul> - <li> - <b>Open in <u>N</u>ew Window</b> - This option opens a new instance of SystemTap GUI. - </li> - <li> - <b><u>O</u>pen Perspective</b> - This submenu lists each of the available perspectives to open: - <ul> - <li>IDE Perspective</li> - <li>Graphing Perspective</li> - </ul> - </li> - <li> - <b>Show <u>V</u>iews</b> - This submenus lists each of the available views to open: - <ul> - <li>Console</li> - <li>Error Log</li> - <li>Functions</li> - <li>Kernel Source</li> - <li>Probe Alias</li> - <li>Other - Lists all views in the application. - <img border="0" src="images/Viewbox1.png"/> - </li> - </ul> - </li> - <li> - <b><u>P</u>references</b> - Due to the breath of this topic it is covered in another section. Please see - <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/> + <p>A: This feature will be restored in a newer version of Systemtap IDE.</p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> @@ -470,7 +330,7 @@ probe timer.ms(1000) { </a> </td> <td style="width: 20%" align="right"> - <a href="SystemTap-Dashboard.html" title="SystemTap Dashboard"> + <a href="Copyright-Information.html" title="Copyright Information"> <img alt="Next" border="0" src="../../../images/next.gif"/> </a> </td> @@ -478,7 +338,7 @@ probe timer.ms(1000) { <tr> <td style="width: 20%" align="left" valign="top">SystemTap IDE</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">SystemTap Dashboard</td> + <td style="width: 20%" align="right" valign="top">Copyright Information</td> </tr> </table> </body> 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 7def54fb8c..63816d718d 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 @@ -33,27 +33,25 @@ <h2 id="Getting_Started">Getting Started</h2> <h3 id="IDE_Tutorial">IDE Tutorial</h3> <h4 id="Lesson_1:_Getting_Started">Lesson 1: Getting Started</h4> - <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 plug-in and are unfamiliar with how to procede. If you cannot yet start + <p>In this tutorial we will orient you with the Systemtap IDE and its functions. At this point we assume + that you are able to run Systemtap plug-in and are unfamiliar with how to proceed. If you cannot yet start the application, please refer to our - <a href="#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. + <b>NOTE:</b> If this is your the first time opening the Systemtap IDE, it will take a while to load as it has to parse the tapsets. </p> - <p>The IDE Perspective's purpose is to allow the user to create, view, and edit Systemtap scripts. There are + <p>The Systemtap IDE's purpose is to allow the user to create, view, and edit Systemtap scripts. There are other editors built in (plain text and the C editor), however, they ultimately exist to facilitate the writing of Systemtap scripts.</p> - <p>In this lesson we will open a new Systemtap script file to familiarize ourselves with the IDE Perspective. + <p>In this lesson we will open a new Systemtap script file to familiarize ourselves with the Systemtap IDE. If you don't already have a project you plan to put your new script in start by creating a new one. Select the <u>F</u>ile menu -> New -> Project -> General -> Project. Follow the wizard to create a new project.</p> - <p>Now you are ready to create the script. Select File -> New -> Other -> Systemtap -> Systemtap Script. Follow the wizard - to provide your script name and the project which will contain it (Use the project we created above).</p> + <p>Now you are ready to create the script. Select File -> New -> Other -> Systemtap -> Systemtap Script. Follow the wizard to provide your script name and the project which will contain it (Use the project we created above).</p> <p>This should open up a new editor with a small stub of a script.</p> <p>At this point proceed to - <a href="SystemTap-IDE.html#Lesson_2:_Writing_Your_First_Script">Lesson 2: Writing Your First Script </a> if you wish to learn how to write your + <a href="#Lesson_2:_Writing_Your_First_Script">Lesson 2: Writing Your First Script</a> if you wish to learn how to write your own script file or - <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script </a> if you wish to run this one. + <a href="#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a> if you wish to run this one. </p> <h4 id="Lesson_2:_Writing_Your_First_Script">Lesson 2: Writing Your First Script</h4> <p>In this tutorial we will guide you through the process of writing your first Systemtap script. It is strongly recommended that you review the @@ -105,19 +103,54 @@ <img border="0" src="images/ContextAssist.png"/> </p> <p>In - <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3</a> you will learn how to run Systemtap scripts in the IDE Perspective. + <a href="#Lesson_3:_Running_Your_Script">Lesson 3</a> you will learn how to run Systemtap scripts in the IDE Perspective. </p> <h4 id="Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</h4> <p>In this lesson we will cover running your script. You may use either the script you wrote in Lesson two or write a new one.</p> - <p>There are two ways to run a script. If you click on the run button in the tool bar that will run the current script as the current user on the local machine. For more control over running options you can create a Launch Configuration. To do so right click on the script editor or the script file in the Project Explorer then select + <p>There are two ways to run a script:</p> + <ul> + <li> + <img border="0" src="images/Run_exc.gif"/> + <b>Simple Run</b> - Clicking this button in the toolbar will run the current script as the current user on the local machine, and will print all script output to the Eclipse console. + </li> + <li> + <b>Run Configuration</b> - For more control over running options, you can use a Run Configuration. To run a script with an existing Run Configuration, open the script file you want to run, then do any of the following: + <ul> + <li>right-click on the script editor or the script file in the Project Explorer, and select + <b>Run As->Systemtap Script</b> + </li> + <li>click on the + <img border="0" src="images/Run_exc.gif"/> + <b>Run As...</b> button on the toolbar + </li> + <li>select either + <b>Run->Run</b> or + <b>Run->Run As->Systemtap Script</b> on the menu bar + </li> + <li>press Ctrl+F11 on the keyboard</li> + </ul> + </li> + </ul> + <p>If any of these options are used when a Run Configuration is not yet created for the script, a new one with default settings will be created for it. If multiple Run Configurations exist, you will be prompted to select which one to run the script with.</p> + <p> + <img border="0" src="images/Multiconfigs.png"/> + </p> + <p>If you know which Run Configuration you want to use, you may simply click the arrow next to the + <img border="0" src="images/Run_exc.gif"/> + <b>Run As</b> button on the toolbar and select from a list of recently-run configurations. + </p> + <p> + <img border="0" src="images/RunConfigDropDown.png"/> + </p> + <p>To create a new Run Configuration, right-click on the script editor or the script file in the Project Explorer then select <b>Run As -> Run Configurations...</b>. Once the dialogue pops up double click on the SystemTap tree item and you should be presented with the following dialogue: </p> <p> <img border="0" src="images/SystemTapRunConfiguration.png"/> </p> - <p>Here you can enter remote host information, run as a different user, as well as various other options for running systemtap. Explore the various tabs and options. The tooltips should provide help in understanding what the various options do. When you are ready click Run to run your script.</p> + <p>Here you can specify the path of the script to run, enter remote host information, run as a different user, as well as various other options for running systemtap. Explore the various tabs and options. The tooltips should provide help in understanding what the various options do. When you are ready click Run to run your script.</p> <p>Now we will demonstrate running Systemtap scripts with graphs. In order to run the chart example you'll need to use the code provided in - <a href="SystemTap-IDE.html#Lesson_2:_Writing_Your_First_Script">Lesson 2: Writing Your First Script </a>: + <a href="#Lesson_2:_Writing_Your_First_Script">Lesson 2: Writing Your First Script</a>: </p> <pre> global read, write, start </pre> @@ -140,63 +173,102 @@ } </pre> <p>To do this select - <b>Run As -> Run Configurations...</b> create a new SystemTap Launch Configuration as you did previously and switch to the graphing tab. + <b>Run As -> Run Configurations...</b> and create a new SystemTap Launch Configuration as you did previously and switch to the graphing tab. </p> <p> <img border="0" src="images/GraphingTab.png"/> </p> <p>Select - <b>Graph the output of this script run</b> and enter the parsing information below. That is the the number of columns for the chart, their titles and regular expressions. The regular expressions are used to parse the console output for the script and determine the values of each column at a certain sample point. The combined regular expression is shown at the bottom of the dialogue box. + <b>Graph the output of this script run</b>, and in the text box labelled + <b>Regular Expression</b>, enter a regular expression that will match the output of your script. Place parentheses () around whatever data you want to capture for graphing. </p> - <p>For this example enter the following: </p> - <pre> Columns: 3 - - TITLE REGULAR EXPRESSION DELIMITER - Time \d+ \D+ - Read \d+ \D+ - Write \d+ \D+ - + <p>For this example, enter the following as your + <b>Regular Expression</b>: + </p> + <pre> (\d+)\t(\d+)\t(\d+) +</pre> + <p>This expression will capture the output produced by the example script. Note that in order to capture data from script output, the output must be formatted into lines/rows. Output-parsing regular expressions try to match individual lines of script output, so make sure your scripts print a line break ("\n") to mark the end of a line. (The line break character does not need to be included in the regular expression.)</p> + <p>Once this expression is entered, a table of + <b>Title</b>s and + <b>Sample Extracted Value</b>s will appear. To test that your regular expression is working as intended, you may enter as + <b>Sample Output</b> a line of text similar to what you expect your script to produce. + </p> + <p>For this example, copy and paste the following line into the + <b>Sample Output</b> box: + </p> + <pre> 10 1000 100 </pre> - <p>The title fields simply display the associated string in the column's header.</p> - <p>Now to add a graph using the parsed output click the - <b>Add...</b> button in the - <b>Graphs</b> section. Select line graph and click - <b>Next</b>. You will be prompted to select a column of the X series and Y series; select "Time" "Read" and "Write" respectively. When the script is executed the - <b>Graph Selector</b> view is opened and it will contain a Data View and the graphs you have created. The Data View chart is populated with live data, in addition to the output in the console. You should see a screen similar to the following: + <p>and enter the following as + <b>Titles</b>: + </p> + <pre> + Time + Read + Write +</pre> + <p>The text boxes displayed under + <b>Sample Extracted Value</b> now show you the values that are captured by your regular expression, which will be plotted in any graphs you create that use those values. + </p> + <p>Now to add a graph using the parsed output, click the + <b>Add...</b> button in the Graph Set section, which will bring up the + <a href="SystemTap-Graphing.html#Create_Graph_Wizard">Create Graph</a> wizard. Select a line graph as the + <b>Graph Type</b>, and enter the following as your Title and series values, then click + <b>Finish</b> to save your changes: + </p> + <pre> + Title: Read Write Count + X Series: Time + Y Series 0: Read + Y Series 1: Write +</pre> + <p>You may also specify additional regular expressions to capture output with. To do this, either press the Down arrow key while typing into the + <b>Regular Expression</b> text box, or click the drop-down arrow of the text box and click the entry labelled + <b>New Regular Expression...</b> + </p> + <p> + <img border="0" src="images/SystemtapNewRegex.png"/> + </p> + <p>You will notice that all data entered in the Graphing menu so far, such as the sample output and graphs, will no longer visible after adding a new regular expression. This is because each regular expression has its own sample output, column titles, and set of graphs (or Graph Set) associated with it. Data for the currently-selected expression is displayed, and since the current expression is blank, so are the column & graph settings.</p> + <p>To capture the example script's output only at intervals of 10 units of time, use the line below as your second regular expression:</p> + <pre> (\d+0)\t(\d+)\t(\d+) +</pre> + <p>Enter the same sample output & title values that were used for the first regular expression. Also add a graph with the same series data as before, and with a title of "Decade Read Write Counts".</p> + <p>When the script is executed under this Run Configuration, the Graph Selector view is opened and it will contain a Data View and any graphs you have created, with a tab for each regular expression's set of graphs. The Data View chart is populated with the output from the console. If you click on the tab labelled + <b>Graph Set 1</b>, you should see a screen similar to the following: </p> <p> <img border="0" src="images/SystemtapGraphView.png"/> </p> - <p>Note that the multiple series graphs (Multi-Line, Multi-Bar, and Multi-Scatter) will request two Y series, Y1 and Y2. In the case of our example, these would be "Read" and "Write". Each series will be assigned a different color value for the purposes of differentiation and will be plotted both in respect to the specified X series.</p> - <p>If you click on - <b>Data View</b> you will see that the data table poplulates from live data parsed from the console: + <p>Switch between the graphs in Graph Set 1 and 2 to see the difference between the two graphs you plotted. If you click on the + <b>Data View</b> tab of either Graph Set, you will see that the data that is being parsed live from the console: </p> <p> <img border="0" src="images/SystemtapGraphDataView.png"/> </p> + <p>You may also create new graphs while in this view, to display data captured by your regular expressions in alternate ways. To create a new graph, first select the Graph Set you want to add a new graph to, then click on the + <img border="0" src="images/New_wiz.gif"/> + <b>Create Graph</b> button, which appears to the left of the Data View tab. This will bring up the same + <a href="SystemTap-Graphing.html#Create_Graph_Wizard">Create Graph</a> wizard that appears when creating a graph in a script's Run Configurations menu. + </p> <p>Those are the basics behind running a script in Systemtap GUI.</p> <h2 id="Concepts">Concepts</h2> <h3 id="SystemTap_IDE_Perspective">SystemTap IDE Perspective</h3> - <ul> - <li> - <img border="0" src="images/Ide.png"/> - <b>IDE Perspective</b> - This is the primary perspective for SystemTap script writers. It contains the - <a href="SystemTap-IDE.html#Function_Browser">Function Browser </a>, - <a href="SystemTap-IDE.html#Kernel_Browser">Kernel Browser </a>, - <a href="SystemTap-IDE.html#Probe_Alias_Browser">Probe Alias Browser </a>, and - <a href="SystemTap-IDE.html#Views_and_Editors">Views and Editors </a>. The IDE Perspective contains the features necessary execute SystemTap scripts and the syntax highlighting and code completion features that facilitate efficient development of scripts. - </li> - </ul> + <p>This is the primary perspective for SystemTap script writers. It contains the + <a href="#Function_Browser">Function Browser</a>, + <a href="#Kernel_Browser">Kernel Browser</a>, + <a href="#Probe_Alias_Browser">Probe Alias Browser</a>, and + <a href="#Views_and_Editors">Views and Editors</a>. The IDE Perspective contains the features necessary execute SystemTap scripts and the syntax highlighting and code completion features that facilitate efficient development of scripts. + </p> <h3 id="STP_Editor">STP Editor</h3> <p>This editor is the most commonly used; it is used for the authoring and editing of Systemtap scripts. It is invoked when the user starts a new file or opens a file with the .stp extension. It provides syntax highlighting, code completion, and run support.</p> <p> <img border="0" src="images/Editor.png"/> </p> <p>See also: - <a href="SystemTap-IDE.html#Menus">Menus </a>, + <a href="#Menus">Menus</a>, - <a href="SystemTap-IDE.html#Example_SystemTap_Scripts">Example SystemTap Scripts </a>, - <a href="SystemTap-IDE.html#Toolbars">Toolbars </a> + <a href="#Example_SystemTap_Scripts">Example SystemTap Scripts</a>, + <a href="#Toolbars">Toolbars</a> </p> <h3 id="Function_Browser">Function Browser</h3> <p>The Funtion Browser lists all of the functions that are defined in the tapset library. Functions are grouped by the file that they are defined. Each listed function has an icon that corresponds to its return type.</p> @@ -249,12 +321,12 @@ <h2 id="Tasks">Tasks</h2> <h3 id="Creating_SystemTap_Scripts">Creating SystemTap Scripts</h3> <p>Create a SystemTap script by selecting - <b>Select File -> New -> Other -> Systemtap -> Systemtap Script</b> in the IDE Perspective. You'll be prompted to enter a name for the file; - <i>make sure that you use a .stp extension or else SystemTap GUI will not recognize the file as a SystemTap script and certain editor and run features will not be active.</i> + <b>File -> New -> Other... -> Systemtap -> Systemtap Script</b> from the menu bar. You'll be prompted to enter a name for the file; + <i>make sure that you use a .stp extension or else the SystemTap IDE will not recognize the file as a SystemTap script and certain editor and run features will not be active.</i> </p> <p>Your new file will be open and ready for coding in the Editor pane.</p> <p>A - <a href="SystemTap-IDE.html#IDE_Tutorial">IDE Tutorial </a> is also provided in the help pages for a step by step demo. + <a href="#IDE_Tutorial">IDE Tutorial</a> is also provided in the help pages for a step by step demo. </p> <p>For advanced SystemTap langauge help please see the SystemTap Development User's Guide and the documentation available at the SystemTap website's documentation page - <a href="http://sourceware.org/systemtap/documentation.html">http://sourceware.org/systemtap/documentation.html</a> @@ -273,54 +345,59 @@ <b><u>W</u>indow-><u>P</u>references</b>. </li> <li>Run Support - See the - <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script </a> help page on a walk through use of the Run command. The Run command allows scripts to be executed directly through SystemTap GUI. + <a href="#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a> help page on a walk through use of the Run command. The Run command allows scripts to be executed directly through SystemTap GUI. </li> </ul> <p>See also: - <a href="SystemTap-IDE.html#Menus">Menus </a>, + <a href="#Menus">Menus</a>, - <a href="SystemTap-IDE.html#Toolbars">Toolbars </a>, - <a href="SystemTap-IDE.html#Example_SystemTap_Scripts">Example SystemTap Scripts </a> + <a href="#Toolbars">Toolbars</a>, + <a href="#Example_SystemTap_Scripts">Example SystemTap Scripts</a> </p> <h3 id="Viewing_Data_Charts">Viewing Data Charts</h3> - <p>Viewing data charts from a SystemTap script is accomplished by running that script with the - <b>Graph the output of this script run</b> option. This is covered in the - <a href="SystemTap-IDE.html#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script </a>. After running a script with the graphing option, the user is presented with the Graph Selector View and the Data Table is loaded by default. The data table immediately begins populating as it receives input back through the console from the running SystemTap script. + <p>Viewing data charts from a SystemTap script is accomplished by running that script with the Run Configurations containing your graphs. This is covered in + <a href="#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a>. After running a script with the graphing option, the user is presented with the Graph Selector View, and the last graph of the final Graph Set is loaded by default. When that view appears, click on the Data View tab of any Graph Set to see it begin populating as it receives input back through the console from the running SystemTap script. </p> <p> <img border="0" src="images/SystemtapGraphDataView.png"/> </p> <h2 id="Reference">Reference</h2> <h3 id="Views_and_Editors">Views and Editors</h3> - <p>This section details the views and editor in relation to the IDE Perspective.</p> + <p>This section details the views and editor in relation to the Systemtap IDE.</p> <h4 id="Views">Views</h4> <p>The IDE Perspective consists of 5 views and and two editors.</p> <ul> <li> <b>Probe Alias Browser</b> - A list of all probe aliases currently available in your version of Systemtap. Covered in detail - <a href="SystemTap-IDE.html#Probe_Alias_Browser">here </a>. + <a href="#Probe_Alias_Browser">here</a>. </li> <li> <b>Function Browser</b> - A list of functions currently supported in your version of Systemtap. Covered in detail - <a href="SystemTap-IDE.html#Function_Browser">here </a>. + <a href="#Function_Browser">here</a>. </li> <li> <b>Kernel Source Browser</b> - Used to display the kernel tree. Covered in detail - <a href="SystemTap-IDE.html#Kernel_Browser">here </a>. + <a href="#Kernel_Browser">here</a>. </li> <li> <b>Console</b> - The console view is where all of the output from the running script is shown. If more then one script is running at the same time you are able to switch between which console is currently displayed by clicking on the "Display Selected Console" button. The script can halt execution here if the user selects the <b>Stop</b> button. The user also has the option of saving the console output to a file, which can be done by clicking the <b>Save log output</b> button at the top of the console. - <img border="0" src="images/IDEConsole.png"/> </li> + </ul> + <p> + <img border="0" src="images/IDEConsole.png"/> + </p> + <ul> <li> <b>Error Log</b> - If the script you tried to run contained errors, this view will become active and display the errors. You can double click on the eror message to jump to the line in the file where the error occured. - <img border="0" src="images/ErrorLog.png"/> </li> </ul> + <p> + <img border="0" src="images/ErrorLog.png"/> + </p> <h4 id="Editors">Editors</h4> - <p>Three editors are available in Systemtap GUI.</p> + <p>Three editors are available in the Systemtap IDE.</p> <ul> <li> <b>STP Editor</b> - This editor is the most commonly used; it is used for the authoring and editing of Systemtap scripts. It is invoked when the user starts a new file or opens a file with the .stp extension. It provides syntax highlighting, code completion, and run support. @@ -333,26 +410,26 @@ </li> </ul> <h3 id="Menus">Menus</h3> - <p>What follows is a comprehension list of the menu options available within the IDE Perspective of Systemtap GUI.</p> + <p>What follows is a comprehension list of the menu options available within the Systemtap IDE.</p> <h4 id="Edit">Edit</h4> <ul> <li> - <b><u>U</u>ndo</b> - Undos the previous editor related action. (Shortcut: Crtl+Z) + <b><u>U</u>ndo</b> - Undos the previous editor related action. (Shortcut: Ctrl+Z) </li> <li> - <b><u>R</u>edo</b> - Redos the previous editor related action removed by Undo. (Shortcut: Crtl+Y) + <b><u>R</u>edo</b> - Redos the previous editor related action removed by Undo. (Shortcut: Ctrl+Y) </li> <li> <b>Cu<u>t</u></b> - Removes the selected text from the editor pane and places it in the clipboard. (Shortcut: Shift+Delete, Ctrl+X) </li> <li> - <b><u>C</u>opy</b> - Copies the selected text from the editor pane and places it in the clipboard. (Shortcut: Ctrl+Insert, Crtl+C) + <b><u>C</u>opy</b> - Copies the selected text from the editor pane and places it in the clipboard. (Shortcut: Ctrl+Insert, Ctrl+C) </li> <li> - <b><u>P</u>aste</b> - Copies the text from the clipboard to the location of the focus in the editor pane. (Shortcut: Shift+Insert, Crtl+V) + <b><u>P</u>aste</b> - Copies the text from the clipboard to the location of the focus in the editor pane. (Shortcut: Shift+Insert, Ctrl+V) </li> <li> - <b>Select <u>A</u>ll</b> - Selects all text within the file in the editor that the focus is currently in. (Shortcut: Crtl+A) + <b>Select <u>A</u>ll</b> - Selects all text within the file in the editor that the focus is currently in. (Shortcut: Ctrl+A) </li> <li> <b><u>F</u>ind/Replace</b> - Opens the Find/Replace dialogue in which users may specify a text string to find and/or replace, with options to search forwards or backwards, the entire document or just the selected lines, and whether or not they want the following options: @@ -365,16 +442,16 @@ </ul> </li> </ul> - <p>(Shortcut: Crtl+F) - + <p>(Shortcut: Ctrl+F)</p> + <p> <img border="0" src="images/Findbox1.png"/> </p> <ul> <li> - <b>Find <u>N</u>ext</b> - Finds the next instance of the search string in the direction indicated in the Find/Replace dialogue box. (Shortcut: Crtl+K) + <b>Find <u>N</u>ext</b> - Finds the next instance of the search string in the direction indicated in the Find/Replace dialogue box. (Shortcut: Ctrl+K) </li> <li> - <b>Find Pre<u>v</u>ious</b> - Finds the previous instance of the search string in the direction indicated in the Find/Replace dialogue box. (Shortcut: Shift+Crtl+K) + <b>Find Pre<u>v</u>ious</b> - Finds the previous instance of the search string in the direction indicated in the Find/Replace dialogue box. (Shortcut: Shift+Ctrl+K) </li> <li> <b><u>I</u>ncremental Find Next</b> - Finds the next occurrence of the text and updates the selection after each character typed. To use Incremental Find: @@ -388,7 +465,7 @@ </ul> </li> <li> - <b>Incre<u>m</u>ental Find Previous</b> - Operates as illustrated in above bullet but in the reverse. (Shortcut: Shift+Crtl+J) + <b>Incre<u>m</u>ental Find Previous</b> - Operates as illustrated in above bullet but in the reverse. (Shortcut: Shift+Ctrl+J) </li> <li> <b>Select <u>A</u>ll</b> - Selects all the text in the file that currently has the focus. (Shortcut: Ctrl+A) @@ -406,17 +483,19 @@ <b><u>B</u>ack</b> - Navigates to the previous file in sequence as they were opened in the editor pane. (Shortcut: Alt+Left) </li> <li> - <b>Last Edit Lo<u>c</u>ation</b> - Moves the focus to the file containing the last known edit. (Shortcut: Crtl+Q) + <b>Last Edit Lo<u>c</u>ation</b> - Moves the focus to the file containing the last known edit. (Shortcut: Ctrl+Q) </li> <li> <b><u>G</u>oto Line...</b> - Moves the focus to the specified line number, with the range of line numbers listed in the dialogue box. (Shortcut: Ctrl+L) - <img border="0" src="images/Gotobox1.png"/> </li> </ul> + <p> + <img border="0" src="images/Gotobox1.png"/> + </p> <h4 id="Run">Run</h4> <ul> <li> - <b><u>R</u>un</b> - Available when a Systemtap script is loaded into the editor, this feature runs the script. You will be prompted to enter details of the remote machine running the systemtapgui server.ShortCut(Ctrl+F5) + <b><u>R</u>un</b> -Available when a Systemtap script is loaded into the editor, this feature runs the script. You will be prompted to run the script either locally, or on a remote machine running the systemtapgui server. If run locally and multiple Run Configurations exist for the script, you will be prompted to choose which of them to run. (Shortcut: Ctrl+F11) </li> </ul> <p> @@ -425,102 +504,56 @@ <h4 id="Window">Window</h4> <ul> <li> - <b>Open in <u>N</u>ew Window</b> - This option opens a new instance of SystemTap GUI. + <b><u>N</u>ew Window</b> - This option opens a new instance of the SystemTap IDE. </li> <li> <b><u>O</u>pen Perspective</b> - This submenu lists each of the available perspectives to open: <ul> - <li>IDE Perspective</li> - <li>Graphing Perspective</li> - <li>Dashboard Perspective</li> + <li>Systemtap IDE</li> + <li>Other... - Lists all other perspectives available to Eclipse.</li> </ul> </li> <li> <b>Show <u>V</u>iews</b> - This submenus lists each of the available views to open: <ul> <li>Console</li> - <li>Error Log</li> <li>Functions</li> <li>Kernel Source</li> <li>Probe Alias</li> - <li>Other - Lists all views in the application.</li> + <li>Systemtap Error Log</li> + <li>Other... - Lists all views in the application.</li> </ul> </li> - </ul> - <p> - <img border="0" src="images/Viewbox1.png"/> - </p> - <ul> <li> <b><u>P</u>references</b> - Due to the breath of this topic it is covered in another section. Please see - <a href="SystemTap-IDE.html#Preferences">Preferences </a>. + <a href="#Preferences">Preferences</a>. </li> </ul> <h3 id="Toolbars">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">Action Bar</h4> <ul> <li> <img border="0" src="images/New_wiz.gif"/> - <b>New File</b> - This button will bring up a dialog to create a new file. When you click ok the file will be opened in the editor window. + <b>New File</b> - This button will bring up a dialogue to create a new file. When you click ok the file will be opened in the editor window. </li> <li> <img border="0" src="images/Run_exc.gif"/> - <b>Run Script</b> - This will compile the open script and start running it. All output will be sent to the console. If there is an error in the script the error will be reported in the ErrorLog. + <b>Simple Run</b> - This will compile the open script and start running it, without using a Run Configuration. All output will be sent to the console. If there is an error in the script the error will be reported in the ErrorLog. </li> - </ul> - <h4 id="Perspective_Selector">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. + <img border="0" src="images/Run_exc.gif"/> + <b>Run As</b> - This compiles & runs the current script, but also searches for a Run Configuration that targets the script, and runs the script with the launch options provided by it. Use this instead of Simple Run when you want graphs to be plotted. (Shortcut: Ctrl+F11) </li> </ul> <h3 id="Preferences">Preferences</h3> <p>This section details each of the options listed under - <b><u>W</u>indow-><u>P</u>references</b>. The Preferences dialog is the dialog used to set user preferences. The Preferences dialog pages can be searched using the filter function. To filter by matching the page title, simply type the name of the page you are seeking and the available pages will be presented below. The filter also searches on keywords such as appearance and java. + <b><u>W</u>indow-><u>P</u>references</b>. The Preferences dialog is used to set user preferences. Its pages can be searched using the filter function. To filter by matching the page title, simply type the name of the page you are seeking in the text box in the top-left corner of the dialog, and the available pages will be presented in the list below. The filter also searches on keywords such as "appearance" and "Java". </p> <ul> <li> - <b>Logging</b> + <b>SystemTap</b> - This section contains options relevant to SystemTap itself. <ul> <li> - <b>Enable logging</b> - This option turns on and off the ability to log data from the console. - </li> - <li> - <b>Logging level</b> - This dropdown box allows you to select one of our levels of logging. - <ul> - <li>Debug - A very large quantity of debug information, difficult to identify what you are looking for but extremely exhaustive.</li> - <li>Info - Displays most information regarding program execution; the default level.</li> - <li>Critical - Lists only critical errors duration execution.</li> - <li>Fatal - Lists only fatal errors during execution.</li> - </ul> - </li> - <li> - <i>Log to</i>' - Specifies where you wish the logging to be written: - <ul> - <li>Console - Writes the debug information directly to the console.</li> - <li>File - Write the debug information to a file.</li> - </ul> - </li> - <li> - <b>File</b> - The location of the file that logging sends the debug information to. - </li> - </ul> - </li> - <li> - <b>SystemTap</b> - This section contains options relevent to SystemTap itself. - <ul> - <li> - <b>Remember window state</b> - Preserves the state of the window on exitting SystemTap GUI. - </li> - <li> - <b>Dashboard Preferences</b> - Preferences relate to the Dashboard Perspective. - <ul> - <li>Additional Modules - Provides for the addition of more modules to the Dashboard. Modules are files containing a SystemTap script and associated metadata.</li> - </ul> - </li> - <li> <b>Environment Variables</b> - Allows the user to set specific values to the following environment variables <ul> <li>LD_LIBRARY_PATH</li> @@ -546,8 +579,10 @@ <li> <b>Graph</b> - Preferences related to graphs. <ul> - <li><u>S</u>how grid lines - Turns on and off painting of the grid lines.</li> + <li><u>S</u>how X/Y grid lines - Turns on and off painting of the grid lines for either axis.</li> + <li><u>M</u>ax data items - Number of maximum samples read from a script's output.</li> <li><u>V</u>iewable data items - Number of maximum samples plotted at any time.</li> + <li><u>X</u>/<u>Y</u> series ticks - Specify the number of labelled number markers on either axis.</li> </ul> </li> </ul> @@ -589,32 +624,16 @@ <li><u>S</u>tring Color - Color of strings.</li> </ul> </li> - <li>C editor - <ul> - <li><u>D</u>efault Color - Color of normal code.</li> - <li><u>K</u>eyword Color - Color of keywords.</li> - <li><u>P</u>reprocessor Color - Color of preprocessor code.</li> - <li><u>C</u>omment Color - Color of comments.</li> - <li><u>T</u>ype Color - Color of items identified as types.</li> - <li><u>S</u>tring Color - Color of strings.</li> - </ul> - </li> </ul> </li> - <li>Typeing - No options available at this time.</li> </ul> </li> <li> - <b>Path</b> + <b>Kernel Source Path</b> - Location of the directory that the kernel source code is pulled from. <ul> - <li><u>K</u>ernel Source Directory - Location of the directory that the kernel source code is pulled from.</li> - <li>Stap - No options available at this time. + <li>Tapsets - Preferences related to tapsets. <ul> - <li>Tapsets - Preferences related to tapsets. - <ul> - <li><u>A</u>dditional Tapsets - Allows you to specify additional tapsets scripts to be added in with every script.</li> - </ul> - </li> + <li><u>A</u>dditional Tapsets - Allows you to specify additional tapsets scripts to be added in with every script.</li> </ul> </li> </ul> @@ -636,6 +655,9 @@ <li> <b>Password</b> - Password for the above user. </li> + <li> + <b>Seconds to Save Data</b> + </li> </ul> </li> </ul> @@ -652,13 +674,19 @@ <p> <b>How do I run a script once I've written it?</b> </p> - <p>A: There are different options as far as running your Systemtap script. Please visit the - <a href="SystemTap-IDE.html#Menus">Menus </a> to learn more about the four ways of running Systemtap scripts. + <p>A: There are two ways to run a script: + -with the + <img border="0" src="images/Run_exc.gif"/> Simple Run button on the toolbar, which runs the script that has editor focus. It will be run without drawing graphs or any other configurations. + -by launching it with a Run Configuration that targets any specified script, even one that is not in the workspace. + </p> + <p>Read + <a href="#Lesson_3:_Running_Your_Script">Lesson 3: Running Your Script</a> and + <a href="#Menus">Menus</a> to learn more about the ways of running Systemtap scripts. </p> <p> - <b>Why does the application seem to hang when switching to the IDE Perspective?</b> + <b>Why does the application seem to hang when switching to the Systemtap IDE?</b> </p> - <p>A: If this is the first time you are trying to open the IDE perspective, or have recently gotten a new version of SystemTap this is expected. In order to generate a full list of all of the available probes, and functions the GUI has to run the stap command. If there are tapsets that do not run correctly using the 'stap -up2' comamnd this takes a long time. In order to build as complete a list as possible it will use a binary filtering algorithm to figure out which tapset function is broken and generate data for all of the others.</p> + <p>A: If this is the first time you are trying to open the Systemtap IDE, or have recently gotten a new version of SystemTap this is expected. In order to generate a full list of all of the available probes, and functions the GUI has to run the stap command. If there are tapsets that do not run correctly using the 'stap -up2' comamnd this takes a long time. In order to build as complete a list as possible it will use a binary filtering algorithm to figure out which tapset function is broken and generate data for all of the others.</p> <h3 id="Example_SystemTap_Scripts">Example SystemTap Scripts</h3> <p>What follows is a few SystemTap Scripts that you may use in SystemTap GUI, taken from and linked to @@ -817,11 +845,7 @@ probe end { } </pre> <h3 id="Guide_to_Regular_Expressions">Guide to Regular Expressions</h3> - <p>Regular expressions are used in SystemTap GUI to define how the GUI interprets information that it recieves - from the script file. If the user wishes to change the regular expression during runtime they may do so by - selecting - <b><u>E</u>dit->Modify <u>P</u>arsing Expression</b>. - </p> + <p>Regular expressions are used for SystemTap graphs to interpret information that it recieves from a script's output.</p> <p>Basic regex (taken from " <a href="http://java.sun.com/j2se/1.5.0/docs/api/">http://java.sun.com/j2se/1.5.0/docs/api/</a> ) - </p> diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Updating-This-Document.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Updating-This-Document.html index 0ecbeb1b03..83189efddd 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Updating-This-Document.html +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/Updating-This-Document.html @@ -12,7 +12,7 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="SystemTap-Dashboard.html" title="SystemTap Dashboard"> + <a href="Copyright-Information.html" title="Copyright Information"> <img alt="Previous" border="0" src="../../../images/prev.gif"/> </a> </td> @@ -20,20 +20,20 @@ <td style="width: 20%" align="right"></td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">SystemTap Dashboard</td> + <td style="width: 20%" align="left" valign="top">Copyright Information</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top"></td> </tr> </table><hr/> <h1 id="Updating_This_Document">Updating This Document</h1> - <p> This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit + <p> This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit <a href="http://wiki.eclipse.org/Linux_Tools_Project/SystemTap/User_Guide">http://wiki.eclipse.org/Linux_Tools_Project/SystemTap/User_Guide</a> . </p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="SystemTap-Dashboard.html" title="SystemTap Dashboard"> + <a href="Copyright-Information.html" title="Copyright Information"> <img alt="Previous" border="0" src="../../../images/prev.gif"/> </a> </td> @@ -45,7 +45,7 @@ <td style="width: 20%" align="right"></td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">SystemTap Dashboard</td> + <td style="width: 20%" align="left" valign="top">Copyright Information</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top"></td> </tr> 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 1d80d4428c..27ff2ea826 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 @@ -48,17 +48,13 @@ <b>Sotware Requirements:</b> </p> <ul> - <li> + <li>Linux kernel v2.6.14 or newer <ul> - <li>Linux kernel v2.6.14 or newer - <ul> - <li>Linux kernel devel and debuginfo packages</li> - </ul> - </li> - <li>Eclipse v3.8/v4.2 or newer</li> - <li>SystemTap v0.7 or newer</li> + <li>Linux kernel devel and debuginfo packages</li> </ul> </li> + <li>Eclipse v3.8/v4.2 or newer</li> + <li>SystemTap v0.7 or newer</li> </ul> <p>Once all dependencies are installed, the easiest way to install the SystemTap plug-in for Eclipse is through the <b> @@ -69,7 +65,6 @@ <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-><u>P</u>references</b>, then going to the SystemTap->IDE->'Kernel Source Path' tab. It is possible to explore the kernel source in your local machine or in the same machine used to run SystemTap scripts. Enter your option and inform the kernel source location. If you selected the remote option, it is necessary to set up the remote machine information at SystemTap->'Remote Server' tab. - 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 plug-in.</p> diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Editor.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Editor.png Binary files differindex 1c04a068f5..4c4bf216c9 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Editor.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Editor.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ErrorLog.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ErrorLog.png Binary files differindex 396397b552..25823b052d 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ErrorLog.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ErrorLog.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Function.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Function.png Binary files differindex a4b6cf3409..dd0654514a 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Function.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Function.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/GraphingTab.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/GraphingTab.png Binary files differindex b3371f6737..82d0399dd2 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/GraphingTab.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/GraphingTab.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/IDEConsole.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/IDEConsole.png Binary files differindex 350a87e416..1a05212043 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/IDEConsole.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/IDEConsole.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/KernelSource.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/KernelSource.png Binary files differindex 4fe0917b55..6ac382ce64 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/KernelSource.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/KernelSource.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Multiconfigs.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Multiconfigs.png Binary files differnew file mode 100644 index 0000000000..09237bea36 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/Multiconfigs.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ProbeAlias.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ProbeAlias.png Binary files differindex 5aa3836dbb..284d3a6c27 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ProbeAlias.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ProbeAlias.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/RunConfigDropDown.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/RunConfigDropDown.png Binary files differnew file mode 100644 index 0000000000..820326ec9a --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/RunConfigDropDown.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/StapDataFilters.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/StapDataFilters.png Binary files differnew file mode 100644 index 0000000000..8db44386d7 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/StapDataFilters.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphDataView.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphDataView.png Binary files differindex 228ee69096..0cb6e9cb84 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphDataView.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphDataView.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphView.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphView.png Binary files differindex a9f84b1399..34486bcefd 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphView.png +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapGraphView.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapNewRegex.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapNewRegex.png Binary files differnew file mode 100644 index 0000000000..fbacb04c32 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/SystemtapNewRegex.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ZoomX.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ZoomX.png Binary files differnew file mode 100644 index 0000000000..72b1f7c2e8 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/Systemtap/User_Guide/images/ZoomX.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF index e2a355d786..bfd64d684e 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %Bundle-Name Bundle-SymbolicName: org.eclipse.linuxtools.systemtap.ui.doc;singleton:=true -Bundle-Version: 2.6.4.qualifier +Bundle-Version: 2.6.5.qualifier Bundle-Vendor: %providerName Require-Bundle: org.eclipse.help Bundle-Localization: plugin diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml index de6b4e0dab..8f3b861bea 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/pom.xml @@ -18,7 +18,7 @@ </parent> <artifactId>org.eclipse.linuxtools.systemtap.ui.doc</artifactId> - <version>2.6.4-SNAPSHOT</version> + <version>2.6.5-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> <name>Linux Tools SystemTap GUI Documentation Plug-in</name> diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml index 00a9fe4467..a6e31947e5 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml @@ -45,7 +45,6 @@ </topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html#Toolbars" label="Toolbars"> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html#Action_Bar" label="Action Bar"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html#Perspective_Selector" label="Perspective Selector"></topic> </topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html#Preferences" label="Preferences"></topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-IDE.html#Frequently_Asked_Questions" label="Frequently Asked Questions"></topic> @@ -62,11 +61,13 @@ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html" label="SystemTap Graphing"> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Getting_Started_2" label="Getting Started"> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Introduction" label="Introduction"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Graphing_Tutorial" label="Graphing Tutorial"></topic> + <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Graphing_Tutorial" label="Graphing Tutorial"> + <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Create_Graph_Wizard" label="Create Graph Wizard"></topic> + </topic> </topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Concepts_2" label="Concepts"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#DataTable" label="DataTable"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#DataGraph_Types" label="DataGraph Types"> + <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Data_Table" label="Data Table"></topic> + <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Data_Graph_Types" label="Data Graph Types"> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Scatter_Graph" label="Scatter Graph"></topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Line_Graph" label="Line Graph"></topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Area_Graph" label="Area Graph"></topic> @@ -76,66 +77,11 @@ <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Filters" label="Filters"></topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Graph_Interaction" label="Graph Interaction"></topic> </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Tasks_2" label="Tasks"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Importing.2FExporting_Data_Sets" label="Importing/Exporting Data Sets"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Importing_a_Data_Set" label="Importing a Data Set"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Exporting_a_Data_Set" label="Exporting a Data Set"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Generating_Graphs" label="Generating Graphs"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Opening_Script_Output" label="Opening Script Output"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Saving_a_Graph_Image" label="Saving a Graph Image"></topic> - </topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Reference_2" label="Reference"> <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Frequently_Asked_Questions_2" label="Frequently Asked Questions"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#Menus_2" label="Menus"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Graphing.html#File" label="File"></topic> - <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"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Dashboard_Tutorial" label="Dashboard Tutorial"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Multiple_Module_Execution" label="Multiple Module Execution"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Concepts_3" label="Concepts"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Modules" label="Modules"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Module_Families" label="Module Families"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Multiple_Graphs" label="Multiple Graphs"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Modules_Browser" label="Modules Browser"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Active_Modules_Browser" label="Active Modules Browser"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Tasks_3" label="Tasks"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Creating_Modules" label="Creating Modules"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Export_Script" label="Export Script"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Create_Module" label="Create Module"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Tips" label="Tips"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Constraints" label="Constraints"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Importing_Modules" label="Importing Modules"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Running_Modules" label="Running Modules"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Multiple_Module_Execution_2" label="Multiple Module Execution"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Graph_Interaction_2" label="Graph Interaction"></topic> - </topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Reference_3" label="Reference"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Frequently_Asked_Questions_3" label="Frequently Asked Questions"></topic> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#Menus_3" label="Menus"> - <topic href="Linux_Tools_Project/Systemtap/User_Guide/SystemTap-Dashboard.html#File_2" label="File"></topic> - <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_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> + <topic href="Linux_Tools_Project/Systemtap/User_Guide/Copyright-Information.html" label="Copyright Information"></topic> <topic href="Linux_Tools_Project/Systemtap/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic> </topic> </toc>
\ No newline at end of file |
