aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCamilo Bernal2013-05-28 15:22:50 (EDT)
committerJeff Johnston2013-05-28 15:58:44 (EDT)
commitba457a0ee5121af9aeb68ec1b690fd8137ee9a11 (patch)
tree55b394eb557e69bd11bc0452284a3a7a228f060e
parent75b5354362c3eefe0253dac61e308b2b94071237 (diff)
downloadorg.eclipse.linuxtools-ba457a0ee5121af9aeb68ec1b690fd8137ee9a11.zip
org.eclipse.linuxtools-ba457a0ee5121af9aeb68ec1b690fd8137ee9a11.tar.gz
org.eclipse.linuxtools-ba457a0ee5121af9aeb68ec1b690fd8137ee9a11.tar.bz2
Callgraph: Synchronize documentation with wikirefs/changes/98/13298/2
Change-Id: I51b7d9c012743f64ec7d69b6adfc4dea4923f9b6 Reviewed-on: https://git.eclipse.org/r/13298 Tested-by: Hudson CI Reviewed-by: Jeff Johnston <jjohnstn@redhat.com> IP-Clean: Jeff Johnston <jjohnstn@redhat.com> Tested-by: Jeff Johnston <jjohnstn@redhat.com>
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/General-Usage.html36
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/User-Guide.html1
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_global_preferences.pngbin0 -> 28436 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_orig_submenu.pngbin0 -> 23549 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_proj_preferences.pngbin0 -> 31033 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_tab.pngbin0 -> 51197 bytes
-rw-r--r--systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_timing_submenu.pngbin0 -> 24212 bytes
7 files changed, 33 insertions, 4 deletions
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/General-Usage.html b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/General-Usage.html
index 9602d92..59e6a97 100644
--- a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/General-Usage.html
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/General-Usage.html
@@ -30,11 +30,41 @@
</tr>
</table><hr/>
<h1 id="General_Usage">General Usage</h1>
- <p>All the profiling plugins (including Eclipse Callgraph) are accessible from the C/C++ perspective. To start using Eclipse Callgraph, right-click on a project then navigate to
- <b>Profile As &gt; Function callgraph</b>.
+ <p>All the profiling plugins (including Eclipse Callgraph) are accessible from the C/C++ perspective. There are two ways to start using Eclipse Callgraph via the
+ <b>Profiling Tools</b> project menu:
+ </p>
+ <p>Using
+ <b>Profiling Tools &gt; Function callgraph</b>
+<center>
+
+ <img border="0" src="images/Callgraph_orig_submenu.png"/>
+</center>
+ </p>
+ <p>or using
+ <b>Profiling Tools &gt; Profile Timing</b> and setting the timing tool to be Callgraph.
+<center>
+
+ <img border="0" src="images/Callgraph_timing_submenu.png"/>
+</center>
+ </p>
+ <p>To properly set the preferences you can go to
+ <b>C/C++-&gt;Profiling-&gt;Categories-&gt;Timing</b> and set the default timing tool to be Callgraph.
+<center>
+
+ <img border="0" src="images/Callgraph_global_preferences.png"/>
+</center>
+ </p>
+ <p>Alternatively, you can set project specific preferences which override workspace preferences by using project
+ <b>Properties-&gt;C/C++ General-&gt;Profiling Categories-&gt;Timing</b>.
+<center>
+
+ <img border="0" src="images/Callgraph_proj_preferences.png"/>
+</center>
+ </p>
+ <p>You can also profile your application using Profile as...-&gt;Local C/C++ Application whereby you have set the profiling tool in the Profiler tab to be Callgraph.
<center>
- <img border="0" src="images/Profile-screen.png"/>
+ <img border="0" src="images/Callgraph_tab.png"/>
</center>
</p>
<p>This will open a dialog from which you can select an executable to profile.
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/User-Guide.html b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/User-Guide.html
index d32ea11..2076c51 100644
--- a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/User-Guide.html
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/User-Guide.html
@@ -25,7 +25,6 @@
<td style="width: 20%" align="right" valign="top">Installation</td>
</tr>
</table><hr/>
- <p>{{#eclipseproject:tools.linuxtools}}</p>
<h1 id="Overview">Overview</h1>
<p>The Eclipse Callgraph plug-in provides a visual function trace of a program. This allows you to view a visualization of selected (or even all) functions used by the profiled application. </p>
<p>This plug-in allows you to profile C/C++ projects directly within the Eclipse IDE, providing various runtime details such as: </p>
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_global_preferences.png b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_global_preferences.png
new file mode 100644
index 0000000..0343129
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_global_preferences.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_orig_submenu.png b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_orig_submenu.png
new file mode 100644
index 0000000..7d4852d
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_orig_submenu.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_proj_preferences.png b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_proj_preferences.png
new file mode 100644
index 0000000..13bc2a5
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_proj_preferences.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_tab.png b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_tab.png
new file mode 100644
index 0000000..f30fc8a
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_tab.png
Binary files differ
diff --git a/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_timing_submenu.png b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_timing_submenu.png
new file mode 100644
index 0000000..5718ed1
--- /dev/null
+++ b/systemtap/org.eclipse.linuxtools.callgraph.docs/Linux_Tools_Project/Callgraph/User_Guide/images/Callgraph_timing_submenu.png
Binary files differ