From 2b0429103d3c68cecc3a469470fcd18443025fac Mon Sep 17 00:00:00 2001 From: Bernd Hufmann Date: Tue, 2 Jul 2013 07:36:15 -0400 Subject: [PATCH] lttng rcp: Add Trace Viewer Help plug-in Change-Id: I2e670902c63b022fc6dd6768273accc3f1c41a2d Signed-off-by: Bernd Hufmann Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/14238 --- .../.empty.dtd | 0 .../RCP Help Builder.launch | 16 +++ .../.gitignore | 3 + .../.project | 36 +++++++ .../org.eclipse.core.resources.prefs | 2 + .../.settings/org.eclipse.core.runtime.prefs | 2 + .../META-INF/MANIFEST.MF | 8 ++ .../README | 19 ++++ .../about.html | 28 ++++++ .../book.css | 59 +++++++++++ .../build.properties | 21 ++++ .../build.xml | 92 ++++++++++++++++++ .../doc/.gitignore | 2 + .../doc/User-Guide.mediawiki | 24 +++++ .../doc/images/home.gif | Bin 0 -> 582 bytes .../doc/images/next.gif | Bin 0 -> 327 bytes .../doc/images/prev.gif | Bin 0 -> 327 bytes .../plugin.properties | 15 +++ .../plugin.xml | 10 ++ .../pom.xml | 86 ++++++++++++++++ .../feature.xml | 6 ++ org.eclipse.linuxtools.tracing.rcp/pom.xml | 1 + pom.xml | 1 + 23 files changed, 431 insertions(+) create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.empty.dtd create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.externalToolBuilders/RCP Help Builder.launch create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.gitignore create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.project create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.resources.prefs create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.runtime.prefs create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/META-INF/MANIFEST.MF create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/README create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/about.html create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/book.css create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/build.properties create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/build.xml create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/doc/.gitignore create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/doc/images/home.gif create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/doc/images/next.gif create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/doc/images/prev.gif create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/plugin.properties create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/plugin.xml create mode 100644 org.eclipse.linuxtools.tracing.rcp.help/pom.xml diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.empty.dtd b/org.eclipse.linuxtools.tracing.rcp.help/.empty.dtd new file mode 100644 index 0000000000..e69de29bb2 diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.externalToolBuilders/RCP Help Builder.launch b/org.eclipse.linuxtools.tracing.rcp.help/.externalToolBuilders/RCP Help Builder.launch new file mode 100644 index 0000000000..2540308b05 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/.externalToolBuilders/RCP Help Builder.launch @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.gitignore b/org.eclipse.linuxtools.tracing.rcp.help/.gitignore new file mode 100644 index 0000000000..543917f24d --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/.gitignore @@ -0,0 +1,3 @@ +Linux_Tools_Project/ +target +toc.xml diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.project b/org.eclipse.linuxtools.tracing.rcp.help/.project new file mode 100644 index 0000000000..c3a37af866 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/.project @@ -0,0 +1,36 @@ + + + org.eclipse.linuxtools.tracing.rcp.help + + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + org.eclipse.ui.externaltools.ExternalToolBuilder + clean,full,incremental, + + + LaunchConfigHandle + <project>/.externalToolBuilders/RCP Help Builder.launch + + + incclean + true + + + + + + org.eclipse.pde.PluginNature + + diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.resources.prefs b/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 0000000000..99f26c0203 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +encoding/=UTF-8 diff --git a/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.runtime.prefs b/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.runtime.prefs new file mode 100644 index 0000000000..5a0ad22d2a --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/.settings/org.eclipse.core.runtime.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +line.separator=\n diff --git a/org.eclipse.linuxtools.tracing.rcp.help/META-INF/MANIFEST.MF b/org.eclipse.linuxtools.tracing.rcp.help/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..c2696ad57f --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/META-INF/MANIFEST.MF @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Bundle-Name +Bundle-Vendor: %Bundle-Vendor +Bundle-Version: 0.0.1.qualifier +Bundle-Localization: plugin +Bundle-SymbolicName: org.eclipse.linuxtools.tracing.rcp.help;singleton:=true +Require-Bundle: org.eclipse.help diff --git a/org.eclipse.linuxtools.tracing.rcp.help/README b/org.eclipse.linuxtools.tracing.rcp.help/README new file mode 100644 index 0000000000..1729158783 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/README @@ -0,0 +1,19 @@ +This describes how to build the documentation found in the o.e.l.tracing.rcp.help +plugin. + + +Your Eclipse environment first needs to have the "Mylyn Wikitext" plugin +installed. It can be found in the default Eclipse repository, under +"Collaboration". + +Once that is installed, you should be able to use the manual Eclipse builder to +generate the doc : select the tracing.rcp.help plugin and choose, in the top-menu, +"Project -> Build Project". + +It uses the build.xml Ant script, but it's recommended to run it from within +Eclipse, since the builder will pass some environment variables that the script +needs. + +You might get a warning from build.properties because of a missing file. This +file gets generated with the rest of the doc, so once you have run these steps +(and refreshed the project if needed), the warning should disappear. diff --git a/org.eclipse.linuxtools.tracing.rcp.help/about.html b/org.eclipse.linuxtools.tracing.rcp.help/about.html new file mode 100644 index 0000000000..c258ef55d8 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/about.html @@ -0,0 +1,28 @@ + + + + +About + + +

About This Content

+ +

June 5, 2006

+

License

+ +

The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise +indicated below, the Content is provided to you under the terms and conditions of the +Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available +at http://www.eclipse.org/legal/epl-v10.html. +For purposes of the EPL, "Program" will mean the Content.

+ +

If you did not receive this Content directly from the Eclipse Foundation, the Content is +being redistributed by another party ("Redistributor") 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 http://www.eclipse.org.

+ + + \ No newline at end of file diff --git a/org.eclipse.linuxtools.tracing.rcp.help/book.css b/org.eclipse.linuxtools.tracing.rcp.help/book.css new file mode 100644 index 0000000000..797473964a --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/book.css @@ -0,0 +1,59 @@ +/* following font face declarations need to be removed for DBCS */ + + +body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, sans-serif; color: #000000} +pre { font-family: Courier, monospace} + +/* end font face declarations */ + +/* following font size declarations should be OK for DBCS */ +body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 12pt; } +pre { font-size: 12pt} + +/* end font size declarations */ + +body { background: #FFFFFF} +h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 } +h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 } +h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 } +h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic } +h5 { font size: 13.5pt; } +p { font-size: 12pt; } +pre { margin-left: 6; font-size: 9pt } + +a:link { color: #006699 } +a:visited { color: #996699 } +a:hover { color: #006699 } + +ul { margin-top: 0; margin-bottom: 10 } +li { margin-top: 0; margin-bottom: 0 } +li p { margin-top: 0; margin-bottom: 0 } +ol { margin-top: 0; margin-bottom: 10 } +dl { margin-top: 0; margin-bottom: 10 } +dt { margin-top: 0; margin-bottom: 0; font-weight: bold } +dd { margin-top: 0; margin-bottom: 0 } +strong { font-weight: bold} +em { font-style: italic} +var { font-style: italic} +div.revision { border-left-style: solid; border-left-width: thin; + border-left-color: #7B68EE; padding-left:5 } +th { font-weight: bold } +.hidden { + display: none; +} + +/* Mike Behm's addition to the style sheet */ +.userinput { font-family: monospace; } +.guitab, .important, .guibutton, .selectblue, .guimenu, .guilabel, +.notetitle { + color: #000000; + font-family: helvetica, arial, sans-serif; + font-weight: bold; + } +div.linux {display:none;} +.firsterm {font-style:italic;} + +.typewriter {font-family:monospace;} +.bold {font-weight:600;} +.linethrough {text-decoration: line-through;} +.underline {text-decoration: underline;} diff --git a/org.eclipse.linuxtools.tracing.rcp.help/build.properties b/org.eclipse.linuxtools.tracing.rcp.help/build.properties new file mode 100644 index 0000000000..b5da501cb9 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/build.properties @@ -0,0 +1,21 @@ +############################################################################### +# Copyright (c) 2013 Ericsson +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Ericsson - Initial API and implementation +############################################################################### + +bin.includes = plugin.xml,\ + META-INF/,\ + about.html,\ + plugin.properties,\ + book.css,\ + doc/ +jars.extra.classpath = platform:/plugin/org.eclipse.mylyn.wikitext.core,\ + platform:/plugin/org.eclipse.mylyn.wikitext.mediawiki.core +src.includes = about.html diff --git a/org.eclipse.linuxtools.tracing.rcp.help/build.xml b/org.eclipse.linuxtools.tracing.rcp.help/build.xml new file mode 100644 index 0000000000..8f1a8af730 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/build.xml @@ -0,0 +1,92 @@ + + + + Generate Eclipse help content for the Linux Tools Trace Viewer user guide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + += 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/LTTng2/User_Guide. + + + + + + + + + + + + + + + + + diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/.gitignore b/org.eclipse.linuxtools.tracing.rcp.help/doc/.gitignore new file mode 100644 index 0000000000..28d48547c4 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/doc/.gitignore @@ -0,0 +1,2 @@ +*.html +*.xml diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki b/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki new file mode 100644 index 0000000000..d5526c6bee --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/doc/User-Guide.mediawiki @@ -0,0 +1,24 @@ += Overview = +The Linux Tools Trace Viewer is a stand-alone application based on Eclipse's +Rich Client Platform (RCP). The purpose of this is to provide a lightweight +application to view and analyze traces. It includes all TMF (Tracing and +Monitoring Framework) features, as well as all features from the LTTng (Linux +Tracing Toolkit next generation) Eclipse integration, which are provided by the +Linux Tools Project. + += Getting Started = +To start the Linux Tools Trace Viewer, go to the directory where the Trace +Viewer is installed and then run the application named '''traceViewer'''. +During startup, the Trace Viewer will create, if necessary, an Eclipse workspace +in the user's home directory with the name ''.traceviewer''. It also creates, if +needed, a default tracing project called ''Tracing''. + +Now the application can be used as described in the User Guide for Linux Tools +LTTng integration (see section [[#References | References]]). + += References = + +* [http://www.eclipse.org/linuxtools/projectPages/lttng/ Linux Tools - LTTng integration] +* [http://www.lttng.org/ LTTng project] +* [http://wiki.eclipse.org/Linux_Tools_Project/TMF/User_Guide TMF User Guide] + diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/images/home.gif b/org.eclipse.linuxtools.tracing.rcp.help/doc/images/home.gif new file mode 100644 index 0000000000000000000000000000000000000000..4472e8ce5b377934abe5910749b8c58591947424 GIT binary patch literal 582 zcmZ?wbhEHb6krfwc*ek>=hf;IH{B?(Il6LneC_)9y7e)Ys}kzgCpT_NZrqsBx;3M1 zYfjfr^Oy#Un1=ILZ(q4_=gaqB7ao7P|N7gr_usES|9bEBw__J?ox6Jb!jmu8UwnP~ z{`vgb@~XsXFsG`()# z)P`jC{<4g|#s1N-6zpQh%P)>bdmCa1Pm6E7bp=kA^+FJoIr3lG~V zK1Oy9RsvS`)>ACq4Fq%r%-n6-%-!@?>#ouFG;c9<)mp7~V2zfGUbChqzqhxVj+(c! zgob7dgSf1qs*0+ttT;m}qx_@Cj~QFpq($VE-iU}uGq>`{h>0ocD2NHm@U(JENoiR` mTx3|l#@Z^BazerJ04F22v4Td(0)|Fr1|zv05e@+g4Aub9HpVdk literal 0 HcmV?d00001 diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/images/next.gif b/org.eclipse.linuxtools.tracing.rcp.help/doc/images/next.gif new file mode 100644 index 0000000000000000000000000000000000000000..e2f8c3e1feeb0541239db4061812008af2225105 GIT binary patch literal 327 zcmZ?wbhEHb6krfwxXQrr@9+D+zn}g6e)He2XMaAO`UhluzxDUq&A;Dn{du|K&)c1U zKb`yw6#sVf_k*54PiFppGV{-i6@Ol={QGw2@4L-^fP#-_?rjlUS1Po@J+-Dz{8ESgwt+{5*!DHj%yExE6hNr2CLGc8SInS{s zf%p?|dHMv5Uuypo=4xzGc2W`Q5bP2Z;_OjzQJkcxFoj=0Ofg7Flus#0T~$PNfx4R7 K(v?Au4Aua3A9>vX literal 0 HcmV?d00001 diff --git a/org.eclipse.linuxtools.tracing.rcp.help/doc/images/prev.gif b/org.eclipse.linuxtools.tracing.rcp.help/doc/images/prev.gif new file mode 100644 index 0000000000000000000000000000000000000000..4fb41501036b940c99c8a839d7459c88eb98385c GIT binary patch literal 327 zcmZ?wbhEHb6krfwxXQrr@9+D+zn}g6e)He2XMaAO`UhluzxDUq&A;Dn{du|K&)c1U zKb`yw6#sVf_k*54PiFppGV{-i6@Ol={QGw2@4L-^fP#-_?rjlUS1PoI4}+ox2M@c;!iyI;EP0M4 zDfSD$=;@GFSru%pQBc literal 0 HcmV?d00001 diff --git a/org.eclipse.linuxtools.tracing.rcp.help/plugin.properties b/org.eclipse.linuxtools.tracing.rcp.help/plugin.properties new file mode 100644 index 0000000000..252d9b3171 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/plugin.properties @@ -0,0 +1,15 @@ +############################################################################### +# Copyright (c) 2013 Ericsson +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Bernd Hufmann - Initial API and implementation +############################################################################### + +#Properties file for org.eclipse.linuxtools.lttng.help +Bundle-Vendor = Eclipse Linux Tools +Bundle-Name = Linux Tools Trace Viewer Help Plug-in diff --git a/org.eclipse.linuxtools.tracing.rcp.help/plugin.xml b/org.eclipse.linuxtools.tracing.rcp.help/plugin.xml new file mode 100644 index 0000000000..8236399816 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/plugin.xml @@ -0,0 +1,10 @@ + + + + + + + + diff --git a/org.eclipse.linuxtools.tracing.rcp.help/pom.xml b/org.eclipse.linuxtools.tracing.rcp.help/pom.xml new file mode 100644 index 0000000000..d6b2c03e16 --- /dev/null +++ b/org.eclipse.linuxtools.tracing.rcp.help/pom.xml @@ -0,0 +1,86 @@ + + + + 4.0.0 + + + linuxtools-lttng-parent + org.eclipse.linuxtools.lttng + 2.1.0-SNAPSHOT + + + org.eclipse.linuxtools.tracing.rcp.help + 0.0.1-SNAPSHOT + eclipse-plugin + + Linux Tools Trace Viewer Help Plug-in + + + + + org.apache.maven.plugins + maven-antrun-plugin + + + generate-documentation + generate-sources + + Generating Trace Viewer Help Files + + + + + + + run + + + + clean-documentation + clean + + Cleaning up generated Trace Viewer Help Files + + + + + + run + + + + + + + org.apache.ant + ant + 1.8.1 + + + + org.apache.ant + ant-launcher + 1.8.1 + + + + org.apache.ant + ant-nodeps + 1.8.1 + + + + + + + + org.eclipse.linuxtools.tracing.rcp + diff --git a/org.eclipse.linuxtools.tracing.rcp/feature.xml b/org.eclipse.linuxtools.tracing.rcp/feature.xml index ea83ea936a..5af6744f3c 100644 --- a/org.eclipse.linuxtools.tracing.rcp/feature.xml +++ b/org.eclipse.linuxtools.tracing.rcp/feature.xml @@ -481,4 +481,10 @@ version="0.0.0" unpack="false"/> + + diff --git a/org.eclipse.linuxtools.tracing.rcp/pom.xml b/org.eclipse.linuxtools.tracing.rcp/pom.xml index 20011ddc89..444deb5ceb 100644 --- a/org.eclipse.linuxtools.tracing.rcp/pom.xml +++ b/org.eclipse.linuxtools.tracing.rcp/pom.xml @@ -65,6 +65,7 @@ + diff --git a/pom.xml b/pom.xml index 6162873445..11d4a3f18a 100644 --- a/pom.xml +++ b/pom.xml @@ -49,6 +49,7 @@ tracingRcp org.eclipse.linuxtools.tracing.rcp + org.eclipse.linuxtools.tracing.rcp.help org.eclipse.linuxtools.tracing.rcp.ui org.eclipse.linuxtools.tracing.rcp.product -- 2.34.1