summaryrefslogtreecommitdiffstatsabout
diff options
context:
space:
mode:
authorCamilo Bernal2013-05-28 15:21:07 (EDT)
committer Jeff Johnston2013-05-28 15:58:12 (EDT)
commit75b5354362c3eefe0253dac61e308b2b94071237 (patch)
tree0153d94228ee4aea180a67d09575752841e6f64a
parentdc8bb459229ec906ce55706617b8f170ba9ea527 (diff)
downloadorg.eclipse.linuxtools-75b5354362c3eefe0253dac61e308b2b94071237.zip
org.eclipse.linuxtools-75b5354362c3eefe0253dac61e308b2b94071237.tar.gz
org.eclipse.linuxtools-75b5354362c3eefe0253dac61e308b2b94071237.tar.bz2
Oprofile: Synchronize documentation with wikirefs/changes/97/13297/2
Change-Id: Iad38591a8b2deae6d423187672c1e9761ac7bbed Reviewed-on: https://git.eclipse.org/r/13297 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--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Launching-A-Profile.html27
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Profiling-Configuration.html9
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Remote-OProfile.html4
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Callgraph_timing_submenu.pngbin0 -> 24212 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_event_timer.pngbin0 -> 19610 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_eventconfig.pngbin0 -> 46239 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_config.pngbin0 -> 48302 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_prefs.pngbin0 -> 28988 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_original_submenu.pngbin0 -> 23836 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_proj_prefs.pngbin0 -> 30564 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_tab.pngbin0 -> 40172 bytes
-rw-r--r--oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Remote-oprofile.pngbin0 -> 70099 bytes
12 files changed, 31 insertions, 9 deletions
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Launching-A-Profile.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Launching-A-Profile.html
index c414adc..0faf352 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Launching-A-Profile.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Launching-A-Profile.html
@@ -40,17 +40,38 @@
<p>To use the one-click launch, right click on the
<i>project</i>, the
<i>binary</i> or in an
- <i>open editor</i> for a source file belonging to that project. Then, navigate to <u>Profile As</u> and click <u>Profile With OProfile</u> to start the launch.
+ <i>open editor</i> for a source file belonging to that project. Here there are two ways to start a launch:
</p>
+ <p>Navigating to <u>Profiling Tools</u> and clicking <u>Profile With OProfile</u></p>
<p>
- <img border="0" src="images/Screenshot-one-click_launch.png"/>
+ <img border="0" src="images/Oprofile_original_submenu.png"/>
+ </p>
+ <p>or navigating to <u>Profiling Tools</u>, clicking on <u>Profile Timing</u> and setting the timing tools to be Oprofile.</p>
+ <p>
+ <img border="0" src="images/Callgraph_timing_submenu.png"/>
+ </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 Oprofile.
+ </p>
+ <p>
+ <img border="0" src="images/Oprofile_global_prefs.png"/>
+ </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>.
+ </p>
+ <p>
+ <img border="0" src="images/Oprofile_proj_prefs.png"/>
+ </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 Oprofile. </p>
+ <p>
+ <img border="0" src="images/Oprofile_tab.png"/>
</p>
<h2 id="Launching_a_Customized_Profile">Launching a Customized Profile</h2>
<p>The OProfile plug-in allows you to configure a profile run using several available OProfile options. These options are exposed via the launch configuration in a user-friendly manner, allowing for a more complex profile. </p>
<p>To customize a profile, right click on the
<i>project</i>, the
<i>binary</i> or in an
- <i>open editor</i> for a source file belonging to that project. Then, navigate to <u>Profile As</u> &gt; <u>Profile Configurations...</u> to open the
+ <i>open editor</i> for a source file belonging to that project. Then, navigate to <u>Profiling Tools</u> &gt; <u>Profile Configurations...</u> to open the
<b>
<i>Profile Configurations</i>
</b> menu. Refer to the
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Profiling-Configuration.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Profiling-Configuration.html
index 050334d..286920b 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Profiling-Configuration.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Profiling-Configuration.html
@@ -46,8 +46,9 @@
<b>
<i>Global Settings</i>
</b> tab configures how the OProfile daemon gathers profiling information. Each option is described below.
-
- <img border="0" src="images/Screenshot-global_config.png"/>
+ </p>
+ <p>
+ <img border="0" src="images/Oprofile_global_config.png"/>
</p>
<dl>
<dt>Kernel Image File (optional)</dt>
@@ -116,7 +117,7 @@
</p>
<p>The event configuration tab will then look like the screenshot below:</p>
<p>
- <img border="0" src="images/Screenshot-oprofile_event_timer.png"/>
+ <img border="0" src="images/Oprofile_event_timer.png"/>
</p>
<h3 id="Regular_Mode">Regular Mode</h3>
<p>If your processor (or kernel) supports hardware profiling registers, there are several configuration options available to you. The availability of these configuration options depend on your processor model or kernel version. With proper support, the
@@ -125,7 +126,7 @@
</b> configuration tab will look like the following screenshot:
</p>
<p>
- <img border="0" src="images/Screenshot-oprofile_eventconfig.png"/>
+ <img border="0" src="images/Oprofile_eventconfig.png"/>
</p>
<p>In
<i>regular mode</i>, the
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Remote-OProfile.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Remote-OProfile.html
index 2a13a31..04305f5 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Remote-OProfile.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Remote-OProfile.html
@@ -49,10 +49,10 @@
</pre>
<p>This is necessary for running a remote command using sudo. </p>
<h2 id="Launching_A_Remote_Profile">Launching A Remote Profile</h2>
- <p>To run OProfile remotely, right-click the project and navigate to "Profile As", then to "Profile Configurations". (Note: there's no One-click launch for remote OProfile). In the new window, double-click the Profile with OProfile (remote) profile configuration. </p>
+ <p>To run OProfile remotely, right-click the project and navigate to "Profiling Tools", then to "Profile Configurations". (Note: there's no One-click launch for remote OProfile). In the new window, double-click the Profile with OProfile (remote) profile configuration. </p>
<p>In the main tab, choose the binary that will be profiled by clicking the "Browse" button under "C/C++ executable".</p>
<p>
- <img border="0" src="images/Screenshot-remote-oprofile.png"/>
+ <img border="0" src="images/Remote-oprofile.png"/>
</p>
<p>The same
<a href="Profiling-Configuration.html#Event_Configuration">Event Configuration</a> Event Configuration options for regular OProfile apply for remote OProfile as well.
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Callgraph_timing_submenu.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Callgraph_timing_submenu.png
new file mode 100644
index 0000000..5718ed1
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Callgraph_timing_submenu.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_event_timer.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_event_timer.png
new file mode 100644
index 0000000..b98ec23
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_event_timer.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_eventconfig.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_eventconfig.png
new file mode 100644
index 0000000..c080c2d
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_eventconfig.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_config.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_config.png
new file mode 100644
index 0000000..1438c20
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_config.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_prefs.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_prefs.png
new file mode 100644
index 0000000..989f379
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_global_prefs.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_original_submenu.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_original_submenu.png
new file mode 100644
index 0000000..05e80eb
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_original_submenu.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_proj_prefs.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_proj_prefs.png
new file mode 100644
index 0000000..9c1f4ab
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_proj_prefs.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_tab.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_tab.png
new file mode 100644
index 0000000..9d0be6e
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Oprofile_tab.png
Binary files differ
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Remote-oprofile.png b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Remote-oprofile.png
new file mode 100644
index 0000000..f91f729
--- /dev/null
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/images/Remote-oprofile.png
Binary files differ