Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Johnston2011-05-31 20:56:42 +0000
committerJeff Johnston2011-05-31 20:59:14 +0000
commitd434db10f5d1f473fd510f892d4e80c2fb359d39 (patch)
tree31b0b30618f8a7d994d5bb9921dcc95ab315fb82 /gcov/org.eclipse.linuxtools.gcov.docs
parentf592e6909726547385686cc32888bc697908d2bb (diff)
downloadorg.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 'gcov/org.eclipse.linuxtools.gcov.docs')
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/.project22
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/ChangeLog14
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Gcov-main-view.html88
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Installation-and-Set-Up.html60
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Opening-gcov-result.html66
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Troubleshooting.html61
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Updating-This-Document.html54
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/User-Guide.html51
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gcov-sort-per-folder.gifbin0 -> 162 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-birt-chart.gifbin0 -> 582 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-export-to-csv.gifbin0 -> 329 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-file.gifbin0 -> 1019 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-function.gifbin0 -> 617 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-binary-file.pngbin0 -> 28661 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-project-explorer.pngbin0 -> 21230 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovannotatedsource.pngbin0 -> 70308 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovview.pngbin0 -> 22143 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/META-INF/MANIFEST.MF7
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/about.html28
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/build-helper.xml71
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/build.properties12
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/extract-markup.xsl9
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/images/home.gifbin0 -> 582 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/images/next.gifbin0 -> 327 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/images/prev.gifbin0 -> 327 bytes
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/plugin.properties12
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/plugin.xml12
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/pom.xml31
-rw-r--r--gcov/org.eclipse.linuxtools.gcov.docs/toc.xml11
29 files changed, 609 insertions, 0 deletions
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/.project b/gcov/org.eclipse.linuxtools.gcov.docs/.project
new file mode 100644
index 0000000000..a62dc2914d
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/.project
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.linuxtools.gcov.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/gcov/org.eclipse.linuxtools.gcov.docs/ChangeLog b/gcov/org.eclipse.linuxtools.gcov.docs/ChangeLog
new file mode 100644
index 0000000000..cd39f1fd5d
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.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-helper.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/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Gcov-main-view.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Gcov-main-view.html
new file mode 100644
index 0000000000..bb23d45e1d
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Gcov-main-view.html
@@ -0,0 +1,88 @@
+<?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>GCov Plug-in User Guide - Gcov main 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">Gcov main view</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="Opening-gcov-result.html" title="Opening gcov result">
+ <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 gcov result</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Troubleshooting</td>
+ </tr>
+ </table><hr/>
+ <h1 id="Gcov_main_view">Gcov main view</h1>
+ <p>The Gcov view displays an overview of coverage information for the whole project.</p>
+ <p>
+ <img border="0" src="images/gcovView.png"/>
+ </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 gcov result as a CSV text file, suitable for any spreadsheet.
+ </li>
+ <li>
+ <img border="0" src="images/Gcov-sort-per-folder.gif"/> : "Sort coverage per folder" button displays gcov result sorted by folder.
+ </li>
+ <li>
+ <img border="0" src="images/Gprof-sort-per-file.gif"/> : "Sort coverage per file" button displays gcov result sorted by file.
+ </li>
+ <li>
+ <img border="0" src="images/Gprof-sort-per-function.gif"/> : "Sort coverage per function" button displays gcov result sorted by function.
+ </li>
+ </ul>
+ <ul>
+ <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 gcov result view.
+ </li>
+ </ul>
+ <p>Double-clicking on a item in the result view will open the corresponding source location, annotated with coverage informations.</p>
+ <p>
+ <img border="0" src="images/gcovAnnotatedSource.png"/>
+ </p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="Opening-gcov-result.html" title="Opening gcov result">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="GCov Plug-in User Guide">
+ <img alt="GCov Plug-in 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 gcov result</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/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Installation-and-Set-Up.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Installation-and-Set-Up.html
new file mode 100644
index 0000000000..9e9f4df901
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Installation-and-Set-Up.html
@@ -0,0 +1,60 @@
+<?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>GCov Plug-in 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="GCov Plug-in 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-gcov-result.html" title="Opening gcov result">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">GCov Plug-in User Guide</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Opening gcov result</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 "-ftest-coverage -fprofile-arcs" options prior to running the tool.</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="GCov Plug-in 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="GCov Plug-in User Guide">
+ <img alt="GCov Plug-in User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right">
+ <a href="Opening-gcov-result.html" title="Opening gcov result">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">GCov Plug-in User Guide</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Opening gcov result</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Opening-gcov-result.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Opening-gcov-result.html
new file mode 100644
index 0000000000..d2aad86cb9
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Opening-gcov-result.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>GCov Plug-in User Guide - Opening gcov result</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 gcov result</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="Gcov-main-view.html" title="Gcov main 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">Gcov main view</td>
+ </tr>
+ </table><hr/>
+ <h1 id="Opening_gcov_result">Opening gcov result</h1>
+ <p>Once the application is compiled and run is finished, several "gcno" and "gcda" files are generated under the project.</p>
+ <p>
+ <img border="0" src="images/gcov-project-explorer.png"/>
+ </p>
+ <p>Double clicking on one of these files will open a dialog to select the associated binary.
+
+ <img border="0" src="images/gcov-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="GCov Plug-in User Guide">
+ <img alt="GCov Plug-in User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right">
+ <a href="Gcov-main-view.html" title="Gcov main 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">Gcov main view</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Troubleshooting.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Troubleshooting.html
new file mode 100644
index 0000000000..986b5c590b
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/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>GCov Plug-in 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="Gcov-main-view.html" title="Gcov main 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">Gcov main 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 gcov plugin, please
+ <a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=xavier.raynaud@st.com&amp;blocked=&amp;bug_file_loc=http%3A%2F%2F&amp;bug_severity=normal&amp;bug_status=NEW&amp;comment=&amp;component=GCov&amp;contenttypeentry=&amp;contenttypemethod=autodetect&amp;contenttypeselection=text%2Fplain&amp;data=&amp;dependson=&amp;description=&amp;flag_type-1=X&amp;flag_type-2=X&amp;flag_type-4=X&amp;flag_type-6=X&amp;flag_type-7=X&amp;flag_type-8=X&amp;form_name=enter_bug&amp;keywords=&amp;op_sys=Linux&amp;priority=P3&amp;product=Linux%20Tools&amp;qa_contact=&amp;rep_platform=PC&amp;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="Gcov-main-view.html" title="Gcov main view">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="GCov Plug-in User Guide">
+ <img alt="GCov Plug-in 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">Gcov main 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/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Updating-This-Document.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/Updating-This-Document.html
new file mode 100644
index 0000000000..52806147a1
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/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>GCov Plug-in 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/GCov/User_Guide">http://wiki.eclipse.org/Linux_Tools_Project/GCov/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="GCov Plug-in User Guide">
+ <img alt="GCov Plug-in 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/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/User-Guide.html b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/User-Guide.html
new file mode 100644
index 0000000000..cba6916039
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/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>GCov Plug-in 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">GCov Plug-in 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 Gcov plugin allows to visualize in eclipse gcov's output (aka *.gcda/*.gcno files).</p>
+ <p>For more details on gcov, visit the GNU Gprof documentation at
+ <a href="http://gcc.gnu.org/onlinedocs/gcc-4.5.0/gcc/Gcov.html">http://gcc.gnu.org/onlinedocs/gcc-4.5.0/gcc/Gcov.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/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gcov-sort-per-folder.gif b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gcov-sort-per-folder.gif
new file mode 100644
index 0000000000..7937f33e02
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gcov-sort-per-folder.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-birt-chart.gif b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-birt-chart.gif
new file mode 100644
index 0000000000..d7d93dbf5d
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-birt-chart.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-export-to-csv.gif b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-export-to-csv.gif
new file mode 100644
index 0000000000..5a0837d1e4
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-export-to-csv.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-file.gif b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-file.gif
new file mode 100644
index 0000000000..915b7f479b
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-file.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-function.gif b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-function.gif
new file mode 100644
index 0000000000..08aef8f7cd
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/Gprof-sort-per-function.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-binary-file.png b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-binary-file.png
new file mode 100644
index 0000000000..4c18fa9c38
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-binary-file.png
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-project-explorer.png b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-project-explorer.png
new file mode 100644
index 0000000000..5c2e43c008
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcov-project-explorer.png
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovannotatedsource.png b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovannotatedsource.png
new file mode 100644
index 0000000000..d3f4358201
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovannotatedsource.png
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovview.png b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovview.png
new file mode 100644
index 0000000000..22a7b36c5c
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/Linux_Tools_Project/GCov/User_Guide/images/gcovview.png
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/META-INF/MANIFEST.MF b/gcov/org.eclipse.linuxtools.gcov.docs/META-INF/MANIFEST.MF
new file mode 100644
index 0000000000..b4863a559f
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/META-INF/MANIFEST.MF
@@ -0,0 +1,7 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %bundleName
+Bundle-SymbolicName: org.eclipse.linuxtools.gcov.docs;singleton:=true
+Bundle-Version: 1.0.0.qualifier
+Bundle-Vendor: %provider
+Require-Bundle: org.eclipse.help
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/about.html b/gcov/org.eclipse.linuxtools.gcov.docs/about.html
new file mode 100644
index 0000000000..c258ef55d8
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.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 (&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/gcov/org.eclipse.linuxtools.gcov.docs/build-helper.xml b/gcov/org.eclipse.linuxtools.gcov.docs/build-helper.xml
new file mode 100644
index 0000000000..aa7660449c
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/build-helper.xml
@@ -0,0 +1,71 @@
+<?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
+
+ Contributors:
+ Red Hat - initial API and implementation
+ -->
+<project name="org.eclipse.linuxtools.gcov.docs" default="all">
+ <description>
+ Generate Eclipse help content for the Linux Tools gcov user guide
+ </description>
+
+ <property name="gcov.help.doc.url.base" value="http://wiki.eclipse.org"/>
+ <property name="gcov.wiki.url.base" value="${gcov.help.doc.url.base}/Linux_Tools_Project/GCov"/>
+ <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 gcov user guide">
+ <mediawiki-to-eclipse-help wikiBaseUrl="${gcov.help.doc.url.base}" title="GCov User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
+
+ <path name="Linux_Tools_Project/GCov/User_Guide" title="GCov Plug-in 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/GCov/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/gcov/org.eclipse.linuxtools.gcov.docs/build.properties b/gcov/org.eclipse.linuxtools.gcov.docs/build.properties
new file mode 100644
index 0000000000..40a7835047
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/build.properties
@@ -0,0 +1,12 @@
+bin.includes = META-INF/,\
+ plugin.xml,\
+ toc.xml,\
+ cheatsheets/,\
+ about.html,\
+ plugin.properties,\
+ doc/,\
+ Linux_Tools_Project/,\
+ tools.xml,\
+ images/
+jars.compile.order = .
+
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/extract-markup.xsl b/gcov/org.eclipse.linuxtools.gcov.docs/extract-markup.xsl
new file mode 100644
index 0000000000..4c4e731948
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.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/gcov/org.eclipse.linuxtools.gcov.docs/images/home.gif b/gcov/org.eclipse.linuxtools.gcov.docs/images/home.gif
new file mode 100644
index 0000000000..4472e8ce5b
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/images/home.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/images/next.gif b/gcov/org.eclipse.linuxtools.gcov.docs/images/next.gif
new file mode 100644
index 0000000000..e2f8c3e1fe
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/images/next.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/images/prev.gif b/gcov/org.eclipse.linuxtools.gcov.docs/images/prev.gif
new file mode 100644
index 0000000000..4fb4150103
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/images/prev.gif
Binary files differ
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/plugin.properties b/gcov/org.eclipse.linuxtools.gcov.docs/plugin.properties
new file mode 100644
index 0000000000..b336d0026e
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/plugin.properties
@@ -0,0 +1,12 @@
+#################################################################################
+# Copyright (c) 2008 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
+#
+# Contributors:
+# Red Hat Incorporated - initial API and implementation
+#################################################################################
+bundleName=GCov Documentation (Incubation)
+provider=Eclipse Linux Tools \ No newline at end of file
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/plugin.xml b/gcov/org.eclipse.linuxtools.gcov.docs/plugin.xml
new file mode 100644
index 0000000000..81b871ea33
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.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/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml b/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml
new file mode 100644
index 0000000000..ab15d69176
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/pom.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (C) 2011, Red Hat, Inc. 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:
+ Red Hat Incorporated - initial implementation
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.eclipse.linuxtools.gcov</groupId>
+ <artifactId>linuxtools-gcov-parent</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>org.eclipse.linuxtools.gcov.docs</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ <packaging>eclipse-plugin</packaging>
+
+ <name>Linux Tools GCov Documentation Plug-in</name>
+
+</project>
diff --git a/gcov/org.eclipse.linuxtools.gcov.docs/toc.xml b/gcov/org.eclipse.linuxtools.gcov.docs/toc.xml
new file mode 100644
index 0000000000..24be60c897
--- /dev/null
+++ b/gcov/org.eclipse.linuxtools.gcov.docs/toc.xml
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="Linux_Tools_Project/GCov/User_Guide/User-Guide.html" label="GCov User Guide">
+ <topic href="Linux_Tools_Project/GCov/User_Guide/User-Guide.html" label="GCov User Guide">
+ <topic href="Linux_Tools_Project/GCov/User_Guide/User-Guide.html" label="Overview"></topic>
+ <topic href="Linux_Tools_Project/GCov/User_Guide/Installation-and-Set-Up.html" label="Installation and Set-Up"></topic>
+ <topic href="Linux_Tools_Project/GCov/User_Guide/Opening-gcov-result.html" label="Opening gcov result"></topic>
+ <topic href="Linux_Tools_Project/GCov/User_Guide/Gcov-main-view.html" label="Gcov main view"></topic>
+ <topic href="Linux_Tools_Project/GCov/User_Guide/Troubleshooting.html" label="Troubleshooting"></topic>
+ <topic href="Linux_Tools_Project/GCov/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic>
+ </topic>
+</toc>

Back to the top