summaryrefslogtreecommitdiffstatsabout
diff options
context:
space:
mode:
authorCamilo Bernal2013-05-28 15:18:50 (EDT)
committer Jeff Johnston2013-05-28 15:59:39 (EDT)
commit813ada6317130d3a5b24d68211b39b2a05d6c78d (patch)
treeaa9a4c6eb9a01306c5532216296bef692cc34ac5
parent5e994ef69ed32541134d691d3ad458730c3319a3 (diff)
downloadorg.eclipse.linuxtools-813ada6317130d3a5b24d68211b39b2a05d6c78d.zip
org.eclipse.linuxtools-813ada6317130d3a5b24d68211b39b2a05d6c78d.tar.gz
org.eclipse.linuxtools-813ada6317130d3a5b24d68211b39b2a05d6c78d.tar.bz2
Perf: Synchronize documentation with wiki user guide.refs/changes/99/13299/2
Change-Id: I09e84f08f95706bdee7f171e1b517410ce5bcfc5 Reviewed-on: https://git.eclipse.org/r/13299 Reviewed-by: Jeff Johnston <jjohnstn@redhat.com> IP-Clean: Jeff Johnston <jjohnstn@redhat.com> Tested-by: Jeff Johnston <jjohnstn@redhat.com>
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Launching-a-Profile.html23
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Profiling-Configuration.html2
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/User-Guide.html1
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Callgraph_timing_submenu.pngbin0 -> 24212 bytes
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_events.pngbin0 -> 50647 bytes
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_global_prefs.pngbin0 -> 28939 bytes
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_original_submenu.pngbin0 -> 23227 bytes
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_proj_prefs.pngbin0 -> 30613 bytes
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_tab.pngbin0 -> 51420 bytes
9 files changed, 21 insertions, 5 deletions
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Launching-a-Profile.html b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Launching-a-Profile.html
index 2ed7ec1..b421e50 100644
--- a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Launching-a-Profile.html
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Launching-a-Profile.html
@@ -33,13 +33,30 @@
<p>Perf plug-in provides useful profile information in a user-friendly interface, gathering the required information from the Perf command-line tool and hooking it into the Eclipse and CDT's facilities.</p>
<p>During a profile run, the Perf plug-in will start, stop and perform other Perf tasks in the background as needed, while the binary being profiled runs as normal.</p>
<h2 id="One-click_launch">One-click launch</h2>
- <p>The Perf plug-in for Eclipse includes a one-click launch feature which profiles the binary with default options. To use the one-click launch, right click on the project, the binary or in an open editor for a source file belonging to that project. Then, navigate to Profile As and click Profile With Perf to start the launch.</p>
+ <p>The Perf plug-in for Eclipse includes a one-click launch feature which profiles the binary with default options. To use the one-click launch, right click on the project, the binary or in an open editor for a source file belonging to that project.Here there are two ways to start a launch:</p>
+ <p>Navigating to Profiling Tools and clicking Profile With Perf</p>
<p>
- <img width="500" border="0" src="images/Perf_oneclicklaunch.png"/>
+ <img border="0" src="images/Perf_original_submenu.png"/>
+ </p>
+ <p>or navigating to Profiling Tools, clicking on Profile Timing and setting the timing tools to be Perf</p>
+ <p>
+ <img border="0" src="images/Callgraph_timing_submenu.png"/>
+ </p>
+ <p>To properly set the preferences you can go to C/C++-&gt;Profiling-&gt;Categories-&gt;Timing and set the default timing tool to be Perf.</p>
+ <p>
+ <img border="0" src="images/Perf_global_prefs.png"/>
+ </p>
+ <p>You can also set project specific preferences which override workspace preferences by using project Properties-&gt;C/C++ General-&gt;Profiling Categories-&gt;Timing. </p>
+ <p>
+ <img border="0" src="images/Perf_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 perf.</p>
+ <p>
+ <img border="0" src="images/Perf_tab.png"/>
</p>
<h2 id="Launching_a_Customized_Profile">Launching a Customized Profile</h2>
<p>The Perf plug-in allows you to configure a profile run using several 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 project, the binary or in an open editor for a source file belonging to that project. Then, navigate to Profile As &gt; Profile Configurations... to open the Profile Configurations menu. Refer to the Profiling Configuration section for more information about configuring a profile.</p>
+ <p>To customize a profile, right click on the project, the binary or in an open editor for a source file belonging to that project. Then, navigate to Profiling Tools &gt; Profile Configurations... to open the Profile Configurations menu. Refer to the Profiling Configuration section for more information about configuring a profile.</p>
<p>After configuring a profile, click the Profile button to launch the profile.</p><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Profiling-Configuration.html b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Profiling-Configuration.html
index 3818446..1bd9edc 100644
--- a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Profiling-Configuration.html
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/Profiling-Configuration.html
@@ -46,7 +46,7 @@
<h2 id="Perf_Events_tab">Perf Events tab</h2>
<p>On this tab it is possible to set up a customized array of events for the profiling or, if desired, go with the Default Event option which overrides all other settings and run Perf with the default event (cycle counting).</p>
<p>
- <img width="900" border="0" src="images/Perf_eventstab.png"/>
+ <img border="0" src="images/Perf_events.png"/>
</p><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/User-Guide.html b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/User-Guide.html
index 46c7c08..23256bf 100644
--- a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/User-Guide.html
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/User-Guide.html
@@ -25,7 +25,6 @@
<td style="width: 20%" align="right" valign="top">Installing</td>
</tr>
</table><hr/>
- <p>{{#eclipseproject:tools.linuxtools}}</p>
<h1 id="Overview">Overview</h1>
<p>PERF is a performance counters subsystem in Linux. Performance counters are CPU hardware registers that count hardware events such as instructions executed and cache-misses suffered. These counters aid in profiling applications to detect hotspots in the application. PERF provides per task, per CPU and per-workload counters, sampling on top of these and source code event annotation.</p>
<p>The PERF plug-in for Eclipse allows the developer to execute profiles in their applications in a seamlessly way, using quick launch actions and visualizing the results in an user-friendly interface.</p><hr/>
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Callgraph_timing_submenu.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Callgraph_timing_submenu.png
new file mode 100644
index 0000000..5718ed1
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Callgraph_timing_submenu.png
Binary files differ
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_events.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_events.png
new file mode 100644
index 0000000..19bf8a9
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_events.png
Binary files differ
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_global_prefs.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_global_prefs.png
new file mode 100644
index 0000000..ff6d333
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_global_prefs.png
Binary files differ
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_original_submenu.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_original_submenu.png
new file mode 100644
index 0000000..3a42c9b
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_original_submenu.png
Binary files differ
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_proj_prefs.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_proj_prefs.png
new file mode 100644
index 0000000..286932d
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_proj_prefs.png
Binary files differ
diff --git a/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_tab.png b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_tab.png
new file mode 100644
index 0000000..a714bc9
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/Linux_Tools_Project/PERF/User_Guide/images/Perf_tab.png
Binary files differ