Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnithra P Janakiraman2010-11-08 14:21:44 +0000
committerAnithra P Janakiraman2010-11-08 14:21:44 +0000
commit5c1f2cf04b1dc74c9840eeebbd5aa7fe9c8e2edc (patch)
tree040e77049adcc06407733f4d25671afa2697054c /systemtap
parentea45de56d07fcf23f3d4c209de239d5d58c2a569 (diff)
downloadorg.eclipse.linuxtools-5c1f2cf04b1dc74c9840eeebbd5aa7fe9c8e2edc.tar.gz
org.eclipse.linuxtools-5c1f2cf04b1dc74c9840eeebbd5aa7fe9c8e2edc.tar.xz
org.eclipse.linuxtools-5c1f2cf04b1dc74c9840eeebbd5aa7fe9c8e2edc.zip
2010-11-03 Anithra P Janakiraman <anithra@linux.vnet.ibm.com>
Initial import of doc plugin
Diffstat (limited to 'systemtap')
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap-feature/feature.xml7
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/.project11
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/Updating-This-Document.html54
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/User-Guide.html18
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/gettingStarted.html95
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/installation.html46
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-editor.pngbin0 -> 43742 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-insert-changelog.pngbin0 -> 57320 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-prepare-changelog-result.pngbin0 -> 16923 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLogPreferences.pngbin0 -> 40088 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Screenshot-FolderSelection_changelogplugin.pngbin0 -> 16111 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF9
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/about.html28
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build-helper.xml61
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build.properties10
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/extract-markup.xsl9
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/home.gifbin0 -> 582 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/next.gifbin0 -> 327 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/notices.html22
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/prev.gifbin0 -> 327 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.properties2
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.xml13
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc-doc.xml5
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml11
24 files changed, 401 insertions, 0 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap-feature/feature.xml b/systemtap/org.eclipse.linuxtools.systemtap-feature/feature.xml
index 88c260db61..2fee079101 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap-feature/feature.xml
+++ b/systemtap/org.eclipse.linuxtools.systemtap-feature/feature.xml
@@ -62,6 +62,13 @@
install-size="0"
version="0.0.0"
unpack="false"/>
+
+ <plugin
+ id="org.eclipse.linuxtools.systemtap.ui.doc"
+ download-size="0"
+ install-size="0"
+ version="0.0.0"/>
+
<plugin
id="org.eclipse.linuxtools.systemtap.ui.graphingapi.ui"
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/.project b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/.project
new file mode 100644
index 0000000000..142ed8e9fb
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/.project
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.linuxtools.systemtap.ui.doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ </buildSpec>
+ <natures>
+ </natures>
+</projectDescription>
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
new file mode 100644
index 0000000000..daca2b4980
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/Updating-This-Document.html
@@ -0,0 +1,54 @@
+<?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>ChangeLog Editor User Guide - Updating This Document</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">Updating This Document</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="ChangeLog-Plug-in-Functions.html" title="ChangeLog Plug-in Functions">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right"></td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">ChangeLog Plug-in Functions</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
+
+ <a href="http://wiki.eclipse.org/Linux_Tools_Project/ChangeLog/User_Guide">http://wiki.eclipse.org/Linux_Tools_Project/ChangeLog/User_Guide</a> .
+ </p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="ChangeLog-Plug-in-Functions.html" title="ChangeLog Plug-in Functions">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="ChangeLog Editor User Guide">
+ <img alt="ChangeLog Editor User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right"></td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">ChangeLog Plug-in Functions</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top"></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/User-Guide.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/User-Guide.html
new file mode 100644
index 0000000000..6559d518f7
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/User-Guide.html
@@ -0,0 +1,18 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>Table of Contents</title>
+</head>
+
+<body>
+<h1>Table of Contents</h1>
+
+<ul>
+<li><a href="gettingstarted/gettingStarted.html">Introduction and Links</a></li>
+<li><a href="gettingstarted/installation.html">Installation</a></li>
+</ul>
+
+</body>
+</html> \ No newline at end of file
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/gettingStarted.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/gettingStarted.html
new file mode 100644
index 0000000000..0cbdcb2d6f
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/gettingStarted.html
@@ -0,0 +1,95 @@
+<a href="../toc.html">Table of Contents</a>
+
+<h1>SystemTap Development User Guide</h1>
+
+Welcome to the SystemTap Development Help pages. This section is intended to provide users with information
+and links about the SystemTap scripting language itself, in addition to a brief introduction to SystemTap
+GUI's structure for new users and a brief explanation of SystemTap.
+
+<h2>SystemTap GUI's Plugin Design</h2>
+
+SystemTap GUI was built with a modular goal in mind, namely, to provide the application as a series of
+plugins so that users may obtain just the ones they need without having to use a heavy-weight application
+should if they didn't need to. The most common example of this is to ship the Dashboard plugin
+independently, allowing non-SystemTap savvy users the ability to execute modules without having to write
+any scripts. The application in its complete state includes three perspective, each with a specific goal:
+
+<ul>
+<li><b>IDE Perspective</b> - Contains script editor and Function, Kernel Source, and Probe Alias browsers
+to assist in the creation and editting of SystemTap scripts.</li>
+<li><b>Graphics Perspective</b> - Graphs data from SystemTap scripts in the desired graph form according
+to a regular expression passed to interpret the data.</li>
+<li><b>Dashboard Perspective</b> - Allows the execution of modules, which are scripts with associated
+metadata that open one or more graphs in a dashboard environment that update in real time.This perspective
+is still under development</li>
+</ul>
+
+Each perspective has full documentation associated with it and is packaged in the respective plugin.
+
+<h2>
+Systemtap
+</h2>
+
+SystemTap provides free software (GPL) infrastructure to simplify the gathering of information about the
+running Linux kernel. This assists diagnosis of a performance or functional problem. SystemTap eliminates
+the need for the developer to go through the tedious and disruptive instrument, recompile, install, and
+reboot sequence that may be otherwise required to collect data.<br><br>
+
+SystemTap provides a simple command line interface and scripting language for writing instrumentation for a
+live running kernel. The internal tapset library as well as the published samples can be used to
+aid reuse and abstraction. <br><br>
+
+Current project members include Red Hat, IBM, Intel, and Hitachi.<br><br>
+
+See also: <a href="http://sourceware.org/systemtap/kprobes-status.html">Current status.</a>
+
+<h2>
+Configuration Tutorial
+</h2>
+
+This tutorial is written to guide a new SystemTap GUI user through some basic post-installation setup in
+order to get the most out of the application.<br>
+
+<h3>Installation</h3>
+
+If SystemTap GUI is not yet installed, or for problems in basic installation, please see the <a href="installation.html">
+installation help page</a>.
+
+<h3>Kernel Source Location</h3>
+
+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->Path tab and setting the location
+there. This configuration detail is relevent to the IDE Perspective only.
+
+<h3>Tutorials</h3>
+
+If you haven't already, you will want to take the IDE and Graphing tutorials. You can find them in the Getting
+Started section of each perspective's help pages. These tutorial provides fundamental knowledge on graphing in SystemTap GUI.
+
+<h3>Preferences (Optional)</h3>
+
+Finally, you may want to set certain non-essential preferences before using SystemTap GUI regularly. Use
+<b><u>W</u>indow-><u>P</u>references</b> to access the Preferences page.
+
+Of particular note are
+Logging->Log To, SystemTap->Environment Variables, SystemTap->Graphing->Refresh Delay,
+SystemTap->IDE->Editor->Syntax Coloring.
+
+<h2>Links to SystemTap Resources</h2>
+
+The following links contain information specific to the SystemTap scripting language.
+
+<ul>
+<li><b>SystemTap website</b> - <a href="http://sourceware.org/systemtap/">http://sourceware.org/systemtap/</a></li>
+<li><b>SystemTap wiki</b> - <a href="http://sourceware.org/systemtap/wiki">http://sourceware.org/systemtap/wiki</a></li>
+<li><b>SystemTap tutorial</b> - <a href="http://sourceware.org/systemtap/tutorial/">http://sourceware.org/systemtap/tutorial/</a>
+<li><b>Full list of documentation</b> - <a href="http://sourceware.org/systemtap/documentation.html">http://sourceware.org/systemtap/documentation.html</a>
+</ul>
+
+The following links are related to the SystemTap GUI project:
+
+<ul>
+<li><b>SystemTap GUI Sourceforge</b> - <a href="https://sourceforge.net/projects/stapgui/">https://sourceforge.net/projects/stapgui/</a>
+<li><b>SystemTap GUI Homepage</b> - <a href="http://stapgui.sourceforge.net/">http://stapgui.sourceforge.net/</a>
+</ul>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/installation.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/installation.html
new file mode 100644
index 0000000000..a90e1ef06b
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/installation.html
@@ -0,0 +1,46 @@
+<a href="../toc.html">Table of Contents</a>
+
+<h2>
+Installation
+</h2>
+
+This section details the steps required for the installation of Systemtap GUI on the user's machine.
+
+<h3>
+Requirements
+</h3>
+
+<b>Hardware Requirements:</b>
+<ul><li>x86, x86_64, ppc64, s390</li></ul>
+
+<b>Sotware Requirements:</b>
+<ul>
+<li>Linux kernel v2.6.14 or newer</li>
+<li>Eclipse v3.4.1</li>
+<li>SystemTap v0.7 or newer</li>
+</ul>
+
+The Gui is a client-server application and the server and client can be installed seperately. The client is an eclipse plugin and requires eclipse to be installed. It provides an IDE to write scripts and a visualizer to view the output in graphical form.
+ The server (stapgui-server) provides stdout/stderr data collection and process management services for processes run on a remote system. The server executes the SystemTap script, collects all output to stderr and stdout from that process, then funnels it via a socket to the client.
+The client and server can be installed on machines with different architectures.This allows users to monitor remote machines. You may also download and build the source yourself.
+
+<br><b>NOTE: The client and server are seperate packages and need to be installed independently.</b> You are viewing this help on the eclipse based client.</br>
+
+<br>NOTE: Installation assumes you already have both Eclipse and SystemTap installed.
+
+<h3>Server</h3>
+
+<ol>
+<li>Install the systemtapguiserver rpm.</li>
+ Eg on Fedora run the command:
+ yum install systemtapguiserver
+<li> Run the command 'stapgui-server'. You will get a message saying "Listening for Connections..." in a minute or so which shows that the server is up and running.</li>
+</ol>
+
+<h3>Client</h3>
+<ol>
+<li> Install the eclipse-systemtapgui rpm.</li>
+ Eg on Fedora run the command:
+ yum install eclipse-systemtapgui
+<li>Launch eclipse and open the SystemTap IDE perspective to start writing scripts.</li>
+</ol>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-editor.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-editor.png
new file mode 100644
index 0000000000..20875f4e57
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-editor.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-insert-changelog.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-insert-changelog.png
new file mode 100644
index 0000000000..85b804b0e0
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-insert-changelog.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-prepare-changelog-result.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-prepare-changelog-result.png
new file mode 100644
index 0000000000..7db94c86e3
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLog-prepare-changelog-result.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLogPreferences.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLogPreferences.png
new file mode 100644
index 0000000000..174d3082c1
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Linuxtools-ChangeLogPreferences.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Screenshot-FolderSelection_changelogplugin.png b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Screenshot-FolderSelection_changelogplugin.png
new file mode 100644
index 0000000000..a78d672ce5
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/Linux_Tools_Project/SystemTap/User_Guide/images/Screenshot-FolderSelection_changelogplugin.png
Binary files differ
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
new file mode 100644
index 0000000000..d6845113b5
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/META-INF/MANIFEST.MF
@@ -0,0 +1,9 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: SystemTap GUI Documentation (Incubation)
+Bundle-SymbolicName: org.eclipse.linuxtools.systemtap.ui.doc;singleton:=true
+Bundle-Version: 2.6.4.qualifier
+Bundle-Vendor: %providerName
+Require-Bundle: org.eclipse.help
+Bundle-RequiredExecutionEnvironment: J2SE-1.5
+Bundle-Localization: plugin
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/about.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/about.html
new file mode 100644
index 0000000000..c258ef55d8
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/about.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+<h2>About This Content</h2>
+
+<p>June 5, 2006</p>
+<h3>License</h3>
+
+<p>The Eclipse Foundation makes available all content in this plug-in (&quot;Content&quot;). Unless otherwise
+indicated below, the Content is provided to you under the terms and conditions of the
+Eclipse Public License Version 1.0 (&quot;EPL&quot;). A copy of the EPL is available
+at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
+For purposes of the EPL, &quot;Program&quot; will mean the Content.</p>
+
+<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is
+being redistributed by another party (&quot;Redistributor&quot;) and different terms and conditions may
+apply to your use of any object code in the Content. Check the Redistributor's license that was
+provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise
+indicated below, the terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p>
+
+</body>
+</html> \ No newline at end of file
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build-helper.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build-helper.xml
new file mode 100644
index 0000000000..717cf5dc46
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build-helper.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="org.eclipse.linuxtools.systemtap.ui.doc" default="all">
+ <description>
+ Generate Eclipse help content for the Linux Tools SystemTapGUI user guide
+ </description>
+
+ <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
+
+ <path id="tasks.classpath" path="bin" />
+ <path id="wikitext.tasks.classpath">
+ <!-- Replace dir with the dir you have wikitext installed into.-->
+ <fileset dir="/usr/share/eclipse/dropins/mylyn-wikitext/eclipse/plugins">
+ <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
+ </fileset>
+ </path>
+
+ <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
+ <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
+
+ <target name="all" description="Generate Eclipse help content for the Linux Tools SystemTapGUI user guide">
+ <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="SystemTapGUI User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
+
+ <path name="Linux_Tools_Project/SystemTap/User_Guide" title="SystemTapGUI User Guide" generateToc="false" />
+ <stylesheet url="book.css" />
+ <pageAppendum>
+ = Updating This Document =
+
+ This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
+ http://wiki.eclipse.org/Linux_Tools_Project/SystemTap/User_Guide .
+ </pageAppendum>
+ </mediawiki-to-eclipse-help>
+ <antcall target="test" />
+ </target>
+
+ <target name="test" description="verify that all of the HTML files are well-formed XML">
+ <echo level="info">
+Validating help content XML and HTML files: The Eclipse help system expects well-formed XML
+
+If validation fails it is because either:
+
+* the userguide source code is poorly formed, or
+* the WikiText MediaWiki parser has a bug
+
+Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source,
+or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block)
+ </echo>
+
+ <!--
+ Don't bother with DTD validation: we only care if the files are well-formed.
+ We therefore provide an empty DTD
+ -->
+ <echo file="tmp/__empty.dtd" message="" />
+ <xmlvalidate lenient="true">
+ <fileset dir="Linux_Tools_Project">
+ <include name="**/*.html" />
+ </fileset>
+ <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd" />
+ </xmlvalidate>
+ <delete dir="tmp" />
+ </target>
+</project>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build.properties b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build.properties
new file mode 100644
index 0000000000..c5f66c76b7
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/build.properties
@@ -0,0 +1,10 @@
+bin.includes = plugin.properties,\
+ META-INF/,\
+ plugin.xml,\
+ toc.xml,\
+ about.html,\
+ doc/,\
+ Linux_Tools_Project/,\
+ images/,\
+ toc-doc.xml
+
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/extract-markup.xsl b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/extract-markup.xsl
new file mode 100644
index 0000000000..4c4e731948
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/extract-markup.xsl
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:mw="http://www.mediawiki.org/xml/export-0.3/">
+ <xsl:output method="text"/>
+
+ <xsl:template match="/">
+ <xsl:value-of select="//mw:text"/>
+ </xsl:template>
+</xsl:stylesheet>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/home.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/home.gif
new file mode 100644
index 0000000000..4472e8ce5b
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/home.gif
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/next.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/next.gif
new file mode 100644
index 0000000000..e2f8c3e1fe
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/next.gif
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/notices.html b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/notices.html
new file mode 100644
index 0000000000..dd6688fd29
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/notices.html
@@ -0,0 +1,22 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+
+<meta name="copyright" content="&#169; Copyright 2009 Eclipse Linux Tools project committers and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <LINK REL="STYLESHEET" HREF="book.css" CHARSET="ISO-8859-1" TYPE="text/css">
+ <title>Legal Notices</title>
+</head>
+<body>
+
+<h3>
+<a NAME="Notices"></a>Notices</h3>
+<p>
+The material in this guide is &#169; Copyright 2009 Eclipse Linux Tools project committers and others.
+</p>
+<p>
+<a href="../about.html">Terms and conditions regarding the use of this guide.</a>
+</p>
+</body>
+</html>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/prev.gif b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/prev.gif
new file mode 100644
index 0000000000..4fb4150103
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/images/prev.gif
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.properties b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.properties
new file mode 100644
index 0000000000..78f049d90a
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.properties
@@ -0,0 +1,2 @@
+pluginName=SystemTap GUI Documentation
+providerName=Eclipse Linux Tools
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.xml
new file mode 100644
index 0000000000..36b56390e1
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/plugin.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plugin>
+<!-- This part should be in a documentation plugin -->
+<!-- Configure the help contribution for this plugin -->
+ <extension point="org.eclipse.help.toc">
+ <toc
+ file="toc-doc.xml"
+ primary="true" />
+ <toc
+ file="toc.xml"
+ primary="false" />
+ </extension>
+</plugin>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc-doc.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc-doc.xml
new file mode 100644
index 0000000000..40af339091
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc-doc.xml
@@ -0,0 +1,5 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="Linux_Tools_Project/SystemTapGUI/User_Guide/User-Guide.html" label="SystemTap GUI User Guide">
+<link toc="toc.xml" />
+<topic href="doc/notices.html" label="Legal"> </topic>
+</toc>
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml
new file mode 100644
index 0000000000..bac2efaaae
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.doc/toc.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?NLS TYPE="org.eclipse.help.toc"?>
+
+<toc label="Systemtap Development User Guide" topic="Linux_Tools_Project/SystemTap/User_Guide/User-Guide.html">
+ <topic label="Introduction and Links" href="Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/gettingStarted.html">
+ <anchor id="gettingstarted"/>
+ </topic>
+ <topic label="Installation" href="Linux_Tools_Project/SystemTap/User_Guide/gettingstarted/installation.html">
+ <anchor id="installation"/>
+ </topic>
+</toc>

Back to the top