diff options
| author | Jeff Johnston | 2011-05-31 20:56:42 +0000 |
|---|---|---|
| committer | Jeff Johnston | 2011-05-31 20:59:14 +0000 |
| commit | d434db10f5d1f473fd510f892d4e80c2fb359d39 (patch) | |
| tree | 31b0b30618f8a7d994d5bb9921dcc95ab315fb82 /gprof | |
| parent | f592e6909726547385686cc32888bc697908d2bb (diff) | |
| download | org.eclipse.linuxtools-d434db10f5d1f473fd510f892d4e80c2fb359d39.tar.gz org.eclipse.linuxtools-d434db10f5d1f473fd510f892d4e80c2fb359d39.tar.xz org.eclipse.linuxtools-d434db10f5d1f473fd510f892d4e80c2fb359d39.zip | |
Add gcov and gprof docs plug-ins.
Diffstat (limited to 'gprof')
35 files changed, 631 insertions, 2 deletions
diff --git a/gprof/org.eclipse.linuxtools.gprof-feature/feature.xml b/gprof/org.eclipse.linuxtools.gprof-feature/feature.xml index 169ad4990b..723b810b98 100644 --- a/gprof/org.eclipse.linuxtools.gprof-feature/feature.xml +++ b/gprof/org.eclipse.linuxtools.gprof-feature/feature.xml @@ -2,7 +2,7 @@ <feature id="org.eclipse.linuxtools.gprof" label="%featureName" - version="0.5.0.qualifier" + version="0.6.0.qualifier" provider-name="%provider"> <description> @@ -29,6 +29,13 @@ unpack="false"/> <plugin + id="org.eclipse.linuxtools.gprof.docs" + download-size="0" + install-size="0" + version="0.0.0" + unpack="false"/> + + <plugin id="org.eclipse.linuxtools.binutils" download-size="0" install-size="0" diff --git a/gprof/org.eclipse.linuxtools.gprof-feature/pom.xml b/gprof/org.eclipse.linuxtools.gprof-feature/pom.xml index 8fb7963672..790f2fd121 100644 --- a/gprof/org.eclipse.linuxtools.gprof-feature/pom.xml +++ b/gprof/org.eclipse.linuxtools.gprof-feature/pom.xml @@ -18,7 +18,7 @@ </parent> <artifactId>org.eclipse.linuxtools.gprof-feature</artifactId> - <version>0.5.0-SNAPSHOT</version> + <version>0.6.0-SNAPSHOT</version> <packaging>eclipse-feature</packaging> <name>Linux Tools GProf Integration Feature</name> diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/.project b/gprof/org.eclipse.linuxtools.gprof.docs/.project new file mode 100644 index 0000000000..dc1b7ac8a9 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/.project @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.eclipse.linuxtools.gprof.docs</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.pde.ManifestBuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.SchemaBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.pde.PluginNature</nature> + </natures> +</projectDescription> diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/ChangeLog b/gprof/org.eclipse.linuxtools.gprof.docs/ChangeLog new file mode 100644 index 0000000000..7dfd8be051 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/ChangeLog @@ -0,0 +1,14 @@ +2011-05-31 Jeff Johnston <jjohnstn@redhat.com> + + * plugin.xml: New file. + * toc.xml: Ditto. + * META-INF/MANIFEST.MF: Ditto. + * images/*.gif: Ditto. + * Linux_Tools_Project/*: Ditto. + * about.html: Ditto. + * build-doc.xml: Ditto. + * build.properties: Ditto. + * extract-markup.xsl: Ditto. + * pom.xml: Ditto. + * toc.xml: Ditto. + * plugin.properties: Ditto.
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/GProf-View.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/GProf-View.html new file mode 100644 index 0000000000..a850946fc2 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/GProf-View.html @@ -0,0 +1,92 @@ +<?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>GProf User Guide - GProf View</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">GProf View</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Opening-gmon-out.html" title="Opening gmon.out"> + <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="Troubleshooting.html" title="Troubleshooting"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Opening gmon.out</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Troubleshooting</td> + </tr> + </table><hr/> + <h1 id="GProf_View">GProf View</h1> + <p>The Gprof view shows which parts of the program consume most of the execution time. It also provides call graph infomation for each function.</p> + <p> + <br/> + <img border="0" src="images/Gprof-view.jpg"/> + </p> + <p> + <br/> Several buttons are available in the toolbar. + </p> + <ul> + <li> + <img border="0" src="images/Gprof-export-to-csv.gif"/> : "Export to CSV" button allows you to export the gprof result as a CSV text file, suitable for any spreadsheet. + </li> + <li> + <img border="0" src="images/Gprof-sort-per-file.gif"/> : "Sort samples per file" button displays gprof result sorted by file. + </li> + <li> + <img border="0" src="images/Gprof-sort-per-function.gif"/> : "Sort samples per function" button displays gprof result sorted by function. + </li> + <li> + <img border="0" src="images/Gprof-sort-per-line.gif"/> : "Sort samples per line" button displays gprof result sorted by line. + </li> + <li> + <img border="0" src="images/Gprof-display-call-graph.png"/> : "Display function call graph" button displays gprof result as a call graph. + </li> + </ul> + <ul> + <li> + <img border="0" src="images/Gprof-sample-time.gif"/> : "Switch samples/time" button allows you to switch result display from samples to time and vice-versa. + </li> + <li> + <img border="0" src="images/Gprof-birt-chart.gif"/> : "Create Chart..." button allows you to create a BIRT chart, with the current lines selected in the gprof result view. + </li> + </ul> + <p>If program is compiled with debug option (e.g. "-g"), double-clicking on a item in the result will open the corresponding source location.</p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Opening-gmon-out.html" title="Opening gmon.out"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="GProf User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Troubleshooting.html" title="Troubleshooting"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Opening gmon.out</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Troubleshooting</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Installation-and-Set-Up.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Installation-and-Set-Up.html new file mode 100644 index 0000000000..64776385f1 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Installation-and-Set-Up.html @@ -0,0 +1,63 @@ +<?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>GProf User Guide - Installation and Set-Up</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">Installation and Set-Up</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="User-Guide.html" title="GProf User Guide"> + <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="Opening-gmon-out.html" title="Opening gmon.out"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">GProf User Guide</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Opening gmon.out</td> + </tr> + </table><hr/> + <h1 id="Installation_and_Set-Up">Installation and Set-Up</h1> + <p>Gprof plugin depends on binutils (such as addr2line, c++filt and nm). Gprof can be used on any platform as soon as these binutils are in PATH. For example, you can use it on windows with cygwin.</p> + <p>First of all, the user has to compile the C/C++ program with profiling enabled using the -pg option prior to running the tool. </p> + <p> + <img border="0" src="images/gprof-compile-step.png"/> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="GProf User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Opening-gmon-out.html" title="Opening gmon.out"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">GProf User Guide</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Opening gmon.out</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Opening-gmon-out.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Opening-gmon-out.html new file mode 100644 index 0000000000..c1c03d0236 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Opening-gmon-out.html @@ -0,0 +1,66 @@ +<?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>GProf User Guide - Opening gmon.out</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">Opening gmon.out</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Installation-and-Set-Up.html" title="Installation and Set-Up"> + <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="GProf-View.html" title="GProf View"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation and Set-Up</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">GProf View</td> + </tr> + </table><hr/> + <h1 id="Opening_gmon.out">Opening gmon.out</h1> + <p>Once the application run is finished, a gmon.out file is generated under the project. + + <img border="0" src="images/gprof-project-explorer.png"/> + </p> + <p>Double clicking on this file will open a dialog to select the associated binary. + + <img border="0" src="images/gprof-binary-file.png"/> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Installation-and-Set-Up.html" title="Installation and Set-Up"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="GProf User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="GProf-View.html" title="GProf View"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation and Set-Up</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">GProf View</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Troubleshooting.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Troubleshooting.html new file mode 100644 index 0000000000..c5eb41f1cb --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Troubleshooting.html @@ -0,0 +1,61 @@ +<?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>GProf User Guide - Troubleshooting</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">Troubleshooting</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="GProf-View.html" title="GProf View"> + <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">GProf View</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="Troubleshooting">Troubleshooting</h1> + <p>If you encounter a problem with gprof plugin, please + <a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=xavier.raynaud@st.com&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=normal&bug_status=NEW&comment=&component=GProf&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&flag_type-1=X&flag_type-2=X&flag_type-4=X&flag_type-6=X&flag_type-7=X&flag_type-8=X&form_name=enter_bug&keywords=&op_sys=Linux&priority=P3&product=Linux%20Tools&qa_contact=&rep_platform=PC&short_desc=">file a bug</a>. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="GProf-View.html" title="GProf View"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="GProf 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">GProf View</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/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Updating-This-Document.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/Updating-This-Document.html new file mode 100644 index 0000000000..5f3813abab --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/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>GProf 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="Troubleshooting.html" title="Troubleshooting"> + <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">Troubleshooting</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/GProf/User_Guide">http://wiki.eclipse.org/Linux_Tools_Project/GProf/User_Guide</a> . + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Troubleshooting.html" title="Troubleshooting"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="GProf User Guide"> + <img alt="GProf 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">Troubleshooting</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/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/User-Guide.html b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/User-Guide.html new file mode 100644 index 0000000000..ac90162e71 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/User-Guide.html @@ -0,0 +1,51 @@ +<?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>GProf User Guide</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">GProf User Guide</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Installation-and-Set-Up.html" title="Installation and Set-Up"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Installation and Set-Up</td> + </tr> + </table><hr/> + <p>{{#eclipseproject:technology.linux-distros}}</p> + <h1 id="Overview">Overview</h1> + <p>The Gprof plugin allows to visualize in eclipse gprof's output (aka gmon.out).</p> + <p>For more details on gprof, visit the GNU Gprof documentation at + <a href="http://sourceware.org/binutils/docs-2.20/gprof/index.html">http://sourceware.org/binutils/docs-2.20/gprof/index.html</a> . + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Installation-and-Set-Up.html" title="Installation and Set-Up"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Installation and Set-Up</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-birt-chart.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-birt-chart.gif Binary files differnew file mode 100644 index 0000000000..d7d93dbf5d --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-birt-chart.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-export-to-csv.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-export-to-csv.gif Binary files differnew file mode 100644 index 0000000000..5a0837d1e4 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-export-to-csv.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sample-time.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sample-time.gif Binary files differnew file mode 100644 index 0000000000..4fc84e4c3a --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sample-time.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-file.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-file.gif Binary files differnew file mode 100644 index 0000000000..915b7f479b --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-file.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-function.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-function.gif Binary files differnew file mode 100644 index 0000000000..08aef8f7cd --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-function.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-line.gif b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-line.gif Binary files differnew file mode 100644 index 0000000000..21f18713da --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-sort-per-line.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-view.jpg b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-view.jpg Binary files differnew file mode 100644 index 0000000000..36d18d2ae9 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/Gprof-view.jpg diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-binary-file.png b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-binary-file.png Binary files differnew file mode 100644 index 0000000000..763e17658e --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-binary-file.png diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-compile-step.png b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-compile-step.png Binary files differnew file mode 100644 index 0000000000..795a649c23 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-compile-step.png diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-display-call-graph.png b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-display-call-graph.png Binary files differnew file mode 100644 index 0000000000..03cdd7e85b --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-display-call-graph.png diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-project-explorer.png b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-project-explorer.png Binary files differnew file mode 100644 index 0000000000..f12999c3ae --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/Linux_Tools_Project/GProf/User_Guide/images/gprof-project-explorer.png diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/META-INF/MANIFEST.MF b/gprof/org.eclipse.linuxtools.gprof.docs/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..17ad273bce --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/META-INF/MANIFEST.MF @@ -0,0 +1,7 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Bundle-Name +Bundle-SymbolicName: org.eclipse.linuxtools.gprof.docs;singleton:=true +Bundle-Version: 1.0.0.qualifier +Require-Bundle: org.eclipse.help +Bundle-Vendor: %Bundle-Vendor diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/about.html b/gprof/org.eclipse.linuxtools.gprof.docs/about.html new file mode 100644 index 0000000000..c258ef55d8 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/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 ("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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>. +For purposes of the EPL, "Program" 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 ("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 <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p> + +</body> +</html>
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/build-doc.xml b/gprof/org.eclipse.linuxtools.gprof.docs/build-doc.xml new file mode 100644 index 0000000000..f372123c92 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/build-doc.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2010 Chris Aniszczyk and others. + 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: + Chris Aniszczyk <caniszczyk@gmail.com> - initial API and implementation + --> + +<project name="org.eclipse.linuxtools.gprof.docs" default="all"> + <description> + Generate Eclipse help content from the Eclipsepedia wiki + </description> + + <property name="gprof.help.doc.url.base" value="http://wiki.eclipse.org"/> + <property name="gprof.wiki.url.base" value="${gprof.help.doc.url.base}/Linux_Tools_Project/GProf"/> + <property name="imageFolder" value="images"/> + + <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 Gprof user guide"> + <mediawiki-to-eclipse-help wikiBaseUrl="${gprof.help.doc.url.base}" title="GProf User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*"> + + <path name="Linux_Tools_Project/GProf/User_Guide" title="GProf 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/GProf/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/gprof/org.eclipse.linuxtools.gprof.docs/build.properties b/gprof/org.eclipse.linuxtools.gprof.docs/build.properties new file mode 100644 index 0000000000..5cb19fcb6d --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/build.properties @@ -0,0 +1,10 @@ +bin.includes = META-INF/,\ + .,\ + notices.html,\ + about.html,\ + plugin.properties,\ + Linux_Tools_Project/,\ + images/,\ + plugin.xml,\ + build-doc.xml,\ + toc.xml diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/extract-markup.xsl b/gprof/org.eclipse.linuxtools.gprof.docs/extract-markup.xsl new file mode 100644 index 0000000000..4c4e731948 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/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/gprof/org.eclipse.linuxtools.gprof.docs/images/home.gif b/gprof/org.eclipse.linuxtools.gprof.docs/images/home.gif Binary files differnew file mode 100644 index 0000000000..4472e8ce5b --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/images/home.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/images/next.gif b/gprof/org.eclipse.linuxtools.gprof.docs/images/next.gif Binary files differnew file mode 100644 index 0000000000..e2f8c3e1fe --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/images/next.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/images/prev.gif b/gprof/org.eclipse.linuxtools.gprof.docs/images/prev.gif Binary files differnew file mode 100644 index 0000000000..4fb4150103 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/images/prev.gif diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/notices.html b/gprof/org.eclipse.linuxtools.gprof.docs/notices.html new file mode 100644 index 0000000000..1e27aef20d --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/notices.html @@ -0,0 +1,22 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + +<meta name="copyright" content="© Copyright 2010 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 © Copyright 2010 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/gprof/org.eclipse.linuxtools.gprof.docs/plugin.properties b/gprof/org.eclipse.linuxtools.gprof.docs/plugin.properties new file mode 100644 index 0000000000..8d53674dd0 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/plugin.properties @@ -0,0 +1,2 @@ +Bundle-Vendor = Eclipse Linux Tools +Bundle-Name = GProf Documentation (Incubation)
\ No newline at end of file diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/plugin.xml b/gprof/org.eclipse.linuxtools.gprof.docs/plugin.xml new file mode 100644 index 0000000000..81b871ea33 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/plugin.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.4"?> +<plugin> + <extension + point="org.eclipse.help.toc"> + <toc + file="toc.xml" + primary="true"> + </toc> + </extension> + +</plugin> diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml b/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml new file mode 100644 index 0000000000..c4cdbf9e29 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/pom.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (C) 2011, Red Hat, Inc. + + 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 +--> +<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>linuxtools-gprof-parent</artifactId> + <groupId>org.eclipse.linuxtools.gprof</groupId> + <version>0.0.1-SNAPSHOT</version> + </parent> + + <artifactId>org.eclipse.linuxtools.gprof.docs</artifactId> + <version>1.0.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> + + <name>Linux Tools Gprof Documentation Plug-in</name> +</project> diff --git a/gprof/org.eclipse.linuxtools.gprof.docs/toc.xml b/gprof/org.eclipse.linuxtools.gprof.docs/toc.xml new file mode 100644 index 0000000000..77b9761910 --- /dev/null +++ b/gprof/org.eclipse.linuxtools.gprof.docs/toc.xml @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="Linux_Tools_Project/GProf/User_Guide/User-Guide.html" label="GProf User Guide"> + <topic href="Linux_Tools_Project/GProf/User_Guide/User-Guide.html" label="GProf User Guide"> + <topic href="Linux_Tools_Project/GProf/User_Guide/User-Guide.html" label="Overview"></topic> + <topic href="Linux_Tools_Project/GProf/User_Guide/Installation-and-Set-Up.html" label="Installation and Set-Up"></topic> + <topic href="Linux_Tools_Project/GProf/User_Guide/Opening-gmon-out.html" label="Opening gmon.out"></topic> + <topic href="Linux_Tools_Project/GProf/User_Guide/GProf-View.html" label="GProf View"></topic> + <topic href="Linux_Tools_Project/GProf/User_Guide/Troubleshooting.html" label="Troubleshooting"></topic> + <topic href="Linux_Tools_Project/GProf/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic> + </topic> +</toc>
\ No newline at end of file diff --git a/gprof/pom.xml b/gprof/pom.xml index 15751da5ff..95fcee6183 100644 --- a/gprof/pom.xml +++ b/gprof/pom.xml @@ -61,6 +61,7 @@ <module>org.eclipse.linuxtools.binutils</module> <module>org.eclipse.linuxtools.dataviewers</module> <module>org.eclipse.linuxtools.gprof</module> + <module>org.eclipse.linuxtools.gprof.docs</module> <module>org.eclipse.linuxtools.gprof-feature</module> <module>org.eclipse.linuxtools.gprof.test</module> </modules> |
