diff options
Diffstat (limited to 'systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts')
14 files changed, 95 insertions, 0 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/concepts.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/concepts.html new file mode 100644 index 0000000000..fbd0152454 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/concepts.html @@ -0,0 +1,16 @@ +<a href="../toc.html">Table of Contents</a> + +<h2> +Concepts +</h2> + +This section of the IDE User Guide covers conceptual topics of the application; the major +components, what they do, and how how you interact with them. + +<ol> +<li><a href="systemtapPerspectives.html">SystemTap Perspectives</a></li> +<li><a href="stpEditor.html">STP Editor</a></li> +<li><a href="functionBrowser.html">Function Browser</a></li> +<li><a href="kernelBrowser.html">Kernel Browser</a></li> +<li><a href="probeAliasBrowser.html">Probe Alias Browser</a></li> +</ol>
\ No newline at end of file diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/functionBrowser.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/functionBrowser.html new file mode 100644 index 0000000000..d71d2c99fe --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/functionBrowser.html @@ -0,0 +1,17 @@ +<a href="../toc.html">Table of Contents</a> > <a href="concepts.html">Concepts</a> + +<h2> +Function Browser +</h2> + +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 corrisponds to its return type. + +<ul> +<li><img src="images/var_str.gif"> String</li> +<li><img src="images/var_long.gif"> Long</li> +<li><img src="images/var_void.gif"> Void</li> +</ul> + +If you double click on any function a call to that function will be added to the active editor at the current cursor location. Also if you right click on a function and click "View Definition" the tapset file where the function is defined will be opened.<br><br> + +<br><img src="images/Function.png"><br><br>
\ No newline at end of file diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Editor.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Editor.png Binary files differnew file mode 100644 index 0000000000..1c04a068f5 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Editor.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Function.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Function.png Binary files differnew file mode 100644 index 0000000000..a4b6cf3409 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/Function.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/KernelSource.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/KernelSource.png Binary files differnew file mode 100644 index 0000000000..4fe0917b55 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/KernelSource.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/ProbeAlias.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/ProbeAlias.png Binary files differnew file mode 100644 index 0000000000..5aa3836dbb --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/ProbeAlias.png diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_long.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_long.gif Binary files differnew file mode 100644 index 0000000000..678467f2d8 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_long.gif diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_str.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_str.gif Binary files differnew file mode 100644 index 0000000000..4f4907c3d6 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_str.gif diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_unk.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_unk.gif Binary files differnew file mode 100644 index 0000000000..10abf0dfad --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_unk.gif diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_void.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_void.gif Binary files differnew file mode 100644 index 0000000000..c804bbb947 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/images/var_void.gif diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/kernelBrowser.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/kernelBrowser.html new file mode 100644 index 0000000000..5153a016f0 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/kernelBrowser.html @@ -0,0 +1,9 @@ +<a href="../toc.html">Table of Contents</a> > <a href="concepts.html">Concepts</a> + +<h2> +Kernel Source Browser +</h2> + +The Kernel Source Browser is used to display the kernel tree. This provides you with a quick way to locate places to add probes. Any file in the Kernel Source tree can be opened by double clicking on it. This will open up the selected file in the Editor view. You can then double click on the ruler next to any line that you wish to probe. If SystemTap can probe that line a probe point will be inserted at the end of the script you were most recently working on. If the line can't be probed, an error message will be displayed.<br><br> + +<br><img src="images/KernelSource.png"><br><br>
\ No newline at end of file diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/probeAliasBrowser.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/probeAliasBrowser.html new file mode 100644 index 0000000000..34dd752fa5 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/probeAliasBrowser.html @@ -0,0 +1,17 @@ +<a href="../toc.html">Table of Contents</a> > <a href="concepts.html">Concepts</a> + +<h2> +Probe Alias Browser +</h2> + +The Probe Alias Browser lists all of the probe aliases that are defined in the tapset library. Probes are grouped based on their type. In addition to the list of probes, each probe lists all of the variables that it has access to. Each variable is listed with an icon that represents its type. Types are as follows: + +<ul> +<li><img src="images/var_str.gif"> String</li> +<li><img src="images/var_long.gif"> Long</li> +<li><img src="images/var_unk.gif"> Unknown</li> +</ul> + +If you double click on any probe alias, probe point will be added to the end of the active editor. Also if you right click on a probe and click "View Definition" the tapset file where the probe is defined will be opened.<br><br> + +<br><img src="images/ProbeAlias.png"><br><br> diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/stpEditor.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/stpEditor.html new file mode 100644 index 0000000000..5d61d56dd9 --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/stpEditor.html @@ -0,0 +1,13 @@ +<a href="../toc.html">Table of Contents</a> > <a href="concepts.html">Concepts</a> + +<h2> +STP Editor +</h2> + +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.<br><br> + +<img src="images/Editor.png"><br><br> + + +See also: <a href="../reference/menus.html">IDE Perspective Menus</a>, +<a href="../reference/exampleScripts.html">Example Scripts</a>, <a href="../reference/toolbars.html">Toolbars</a> diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/systemtapPerspectives.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/systemtapPerspectives.html new file mode 100644 index 0000000000..dedb6ff80f --- /dev/null +++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.ide/documentation/html/concepts/systemtapPerspectives.html @@ -0,0 +1,23 @@ +<a href="../toc.html">Table of Contents</a> > <a href="concepts.html">Concepts</a> + +<h2> +SystemTap Perspectives +</h2> + +SystemTap has three perspectives built into it, each with its own purpose. + +<ol> +<li><img src="../reference/images/toolbars/ide.png"> <b>IDE Perspective</b> - This will be the primary perspective for SystemTap script writers. It contains +the <a href="stpEditor.html">editor</a>, <a href="functionBrowser.html">Function Browser</a>, +<a href="kernelBrowser.html">Kernel Browser</a>, <a href="probeAliasBrowser.html">Probe Alias Browser</a>, +and <a href="../reference/viewsAndEditors.html#console">console/error log</a>. The IDE Perspective contains +the features necessary to <a href="">run SystemTap scripts</a> and the syntax highlighting and code +completion features to facilitate efficient development.</li> +<li><img src="../reference/images/toolbars/graphing.png"> <b>Graphing Perspective</b> - This perspective is invoked when the user calls the Run /w Chart option. +It defaults to showing a data table containing the script results and is capable of producing six different +chart types: Line Graph, Multi-Line Graph, Bar Graph, Multi-Bar Graph, Scatter Graph, and Multi-Scatter +Graph.</li> +<li><img src="../reference/images/toolbars/dash.png"><b>Dashboard Perspective</b> - This perspective will be capable of storing meta-data related to +each graph such as filters, aggregates, and display options in addition to showing a "dashboard" interface +with multiple graphs updating simultaneously. It is currently still under development.</li> +</ol>
\ No newline at end of file |
