2011-02-11 Severin Gehwolf <sgehwolf@redhat.com>

	* Update Oprofile documentation	to reflect opxml removal.

5 files changed, 51 insertions, 50 deletions

diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/ChangeLog b/oprofile/org.eclipse.linuxtools.oprofile.doc/ChangeLog
index 7df1d42bea..9164b425ab 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/ChangeLog
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/ChangeLog
@@ -1,3 +1,11 @@
+2011-02-11  Severin Gehwolf  <sgehwolf@redhat.com>
+
+	* Linux_Tools_Project/OProfile/User_Guide/Installation-and-Set-Up.html: Update Oprofile documentation
+	to reflect opxml removal.
+	* Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html: Ditto. 
+	* Linux_Tools_Project/OProfile/User_Guide/User-Guide.html: Ditto.
+	* toc.xml: Ditto.
+
 2010-10-19  Alexander Kurtakov  <akurtako@redhat.com>
 
 	* src: Removed.
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Installation-and-Set-Up.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Installation-and-Set-Up.html
index 94e8b83092..570dbc2f69 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Installation-and-Set-Up.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Installation-and-Set-Up.html
@@ -48,21 +48,17 @@
 		<ul>
 			<li>If you are using a distro-supplied version of Eclipse and installed the plug-in via the update site, the plug-in directory will most likely be under 
 				<i><code>~/.eclipse</code></i>. To find the exact location of the plug-in directory in this case, use the following command:
-				<dl>
-					<dd><code>find ~/.eclipse -name 'org.eclipse.linuxtools.oprofile.core_*'</code></dd>
-				</dl>
 			</li>
+			<li><code>find ~/.eclipse -name 'org.eclipse.linuxtools.oprofile.core_*'</code></li>
 			<li>Alternatively, if you are using an extracted tarball of Eclipse (i.e. you downloaded a 
 				<i><code>.tar.gz</code></i> from 
 				<a href="http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>), then the plug-in will most likely be in the <code>plugins</code> sub-directory of where you extracted it.
-				<dl>
-					<dd>For example, if you extracted the tarball to <code>
-						<i>/home/ksebasti</i></code>, your Eclipse installation would be in <code>
-						<i>/home/ksebasti/eclipse</i></code>. In this case, you should use the following command to find the exact location of the plug-in directory:
-					</dd>
-					<dd><code>find /home/ksebasti/eclipse -name 'org.eclipse.linuxtools.oprofile.core_*'</code></dd>
-				</dl>
 			</li>
+			<li>For example, if you extracted the tarball to <code>
+				<i>/home/ksebasti</i></code>, your Eclipse installation would be in <code>
+				<i>/home/ksebasti/eclipse</i></code>. In this case, you should use the following command to find the exact location of the plug-in directory:
+			</li>
+			<li><code>find /home/ksebasti/eclipse -name 'org.eclipse.linuxtools.oprofile.core_*'</code></li>
 		</ul>
 		<p>
 			<b>Note:</b> In both cases, the quotes (') and asterisk (*) are necessary.
@@ -73,8 +69,9 @@
 </pre>
 		<p>Once you find the plug-in directory, navigate to its <code>
 			<i>natives/linux/scripts</i></code> subdirectory. Using our previous example:
-			<br/><code>cd /home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core_0.2.0.200904131051/natives/linux/scripts</code>
 		</p>
+		<pre>$ cd /home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core_0.2.0.200904131051/natives/linux/scripts
+</pre>
 		<p>The <code>
 			<i>natives/linux/scripts</i></code> subdirectory contains the installation scripts you will need to run in order to allow OProfile to run as root.
 		</p>
@@ -103,9 +100,8 @@
 			<i><code>natives/linux/scripts</code></i> subdirectory of the plug-in directory (as in 
 			<a href="Installation-and-Set-Up.html#Step_1_-_Locate_the_Installation_Scripts">Step 1 - Locate the Installation Scripts</a>), run your selected install script:
 		</p>
-		<dl>
-			<dd><code>./install.sh</code></dd>
-		</dl>
+		<pre> # ./install.sh
+</pre>
 		<p>Successful output will look like this:</p>
 		<pre>./install.sh
 Eclipse-OProfile plugin install successful.
@@ -115,9 +111,8 @@ Eclipse-OProfile plugin install successful.
 			<i><code>/etc</code></i> subdirectories, while 
 			<i><code>install-noconsolehelper.sh</code></i> runs the command <code>visudo</code>. If you wish to simply run either install script without logging in as root, use:
 		</p>
-		<dl>
-			<dd><code>su -c './install.sh'</code></dd>
-		</dl>
+		<pre> su -c './install.sh'
+</pre>
 		<p>This command will run only the install script as the root user, then return control to the regular user. Note that you will still need to enter the root password to make this work. If you receive an error message, refer to the 
 			<a href="Troubleshooting.html#Troubleshooting">Troubleshooting</a> section.
 		</p>
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html
index 952d5526aa..14f09ef70d 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html
@@ -86,14 +86,17 @@ fi
 		<p>The <code>
 			<i>install.sh</i></code> script is fixed in the most recent version of the OProfile plug-in for Eclipse, but not in the 0.2.0 release.
 		</p>
-		<h3 id="Error:_cannot_find_opxml_binary.2C_required_plugin_missing">Error: cannot find opxml binary, required plugin missing</h3>
+		<h3 id="Error:_cannot_find_opxml_binary.2C_required_plugin_missing_.28Deprecated.29">Error: cannot find opxml binary, required plugin missing (Deprecated)</h3>
+		<p>
+			<b>NOTE: As of Linux Tools version 0.7.0 opxml is NOT required anymore.</b>
+		</p>
 		<p>This can occur if the native binary <code>
-			<i>opxml</i></code> is not found. This binary is required for proper operation of the plug-in.
+			<i>opxml</i></code> is not found. This binary is required for proper operation of the oprofile plug-in version &lt; 0.7.0 plug-in. <code>opxml</code> is not required for oprofile &gt;= 0.7.0.
 		</p>
 		<p>Solution: If the <code>
 			<i>org.eclipse.linuxtools.oprofile.core.linux.{x86,x86_64,ppc}</i></code> directories exist (in the Eclipse <code>
 			<i>plugins</i></code> directory), refer to the 
-			<a href="Troubleshooting.html#Rebuilding_opxml">Rebuilding opxml</a> section for instructions on rebuilding the binary and placing it in the proper directory. Otherwise, re-install the plug-in.
+			<a href="#Rebuilding_opxml_(Deprecated)">Rebuilding opxml</a> section for instructions on rebuilding the binary and placing it in the proper directory. Otherwise, re-install the plug-in.
 		</p>
 		<h2 id="No_Samples_From_A_Profile">No Samples From A Profile</h2>
 		<p>It is possible for a profile run of a program to return no samples, resulting in no <code>current</code> session displayed. This is not always indicative of a problem with either OProfile or the profiled program. OProfile is a system-wide profiling tool; hence, other active processes running on your system may overshadow your program. This is particularly true if the profiled program is not CPU intensive. </p>
@@ -123,19 +126,17 @@ fi
 		<p>If the OProfile daemon log file is too large, the log reader may hang and possibly cause the OProfile plug-in to crash. This occurs when the 
 			<i>verbosity</i> option is set to <code>all</code>, which results in several hundred MiB of text in the log over several profile runs. If you do require all this data in the log file, do not launch the log reader. Delete or backup the log file before running the log reader again.
 		</p>
-		<h2 id="Errors_Related_to_opxml">Errors Related to opxml</h2>
+		<h2 id="Errors_Related_to_opxml_.28Deprecated.29">Errors Related to opxml (Deprecated)</h2>
+		<p>
+			<b>NOTE: As of Linux Tools version 0.7.0 opxml is NOT required anymore.</b>
+		</p>
 		<p><code>opxml</code> is the native program that bridges OProfile and the OProfile plug-in for Eclipse. In some cases, some errors may be caused by problems with <code>opxml</code>. To verify if this is the case, run <code>opxml</code>.</p>
 		<p><code>opxml</code> is normally located in the Eclipse <code>
 			<i>plugins</i></code> directory, similar to the install scripts described in 
 			<a href="Installation-and-Set-Up.html#Step_1_-_Locate_the_Installation_Scripts">Step 1 - Locate the Installation Scripts</a>. However, depending on your platform, the location of <code>opxml</code> will be different. To determine what your platform is, run the following command at a terminal:
 		</p>
-		<dl>
-			<dd>
-				<dl>
-					<dd><code>uname -m</code></dd>
-				</dl>
-			</dd>
-		</dl>
+		<pre> uname -m
+</pre>
 		<p>Depending on the output, locate the following directory in the same manner as 
 			<a href="Installation-and-Set-Up.html#Step_1_-_Locate_the_Installation_Scripts">Step 1 - Locate the Installation Scripts</a>, and change into that directory:
 		</p>
@@ -162,33 +163,31 @@ fi
 			</tr>
 		</table>
 		<p>For example, if you are running Eclipse on a 64bit machine (i.e. x86_64), you should run the following command to find the location of <code>opxml</code>:</p>
-		<dl>
-			<dd><code>$ find /home/ksebasti/eclipse -name 'org.eclipse.linuxtools.oprofile.core.linux.x86_64_*'</code></dd>
-		</dl>
+		<pre> $ find /home/ksebasti/eclipse -name 'org.eclipse.linuxtools.oprofile.core.linux.x86_64_*'
+</pre>
 		<p>This will display the following output (or similar):</p>
-		<dl>
-			<dd><code>/home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core.linux.x86_64_0.2.0.200904201514</code></dd>
-		</dl>
+		<pre> /home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core.linux.x86_64_0.2.0.200904201514
+</pre>
 		<p>Navigate into that directory:</p>
-		<dl>
-			<dd><code>$ cd /home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core.linux.x86_64_0.2.0.200904201514/os/linux/x86_64</code></dd>
-		</dl>
+		<pre> $ cd /home/ksebasti/eclipse/plugins/org.eclipse.linuxtools.oprofile.core.linux.x86_64_0.2.0.200904201514/os/linux/x86_64
+</pre>
 		<p>Once you have navigated to the right directory, run the following command:</p>
-		<dl>
-			<dd><code>./opxml info</code></dd>
-		</dl>
+		<pre> ./opxml info
+</pre>
 		<p>Check that the paths in the <code>defaults</code> section are correct. If the output is similar to the output of the command <code>ophelp</code>, but formatted as XML, then this might not be the problem. However, if running <code>opxml</code> produces an error, it may be the root cause. A common error on some systems is that they use an older version of the C runtime libraries (i.e. <code>glibc</code>). Refer to 
-			<a href="Troubleshooting.html#Rebuilding_opxml">Rebuilding opxml</a> for a solution to this error.
+			<a href="#Rebuilding_opxml_(Deprecated)">Rebuilding opxml</a> for a solution to this error.
 		</p>
 		<p>In any case, if there is an error please look for an 
 			<a href="https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;classification=Technology&amp;product=Linux+Tools&amp;component=OProfile&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;bug_file_loc_type=allwordssubstr&amp;bug_file_loc=&amp;status_whiteboard_type=allwordssubstr&amp;status_whiteboard=&amp;keywords_type=allwords&amp;keywords=&amp;emailtype1=substring&amp;email1=&amp;emailtype2=substring&amp;email2=&amp;bugidtype=include&amp;bug_id=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;cmdtype=doit&amp;order=Reuse+same+sort+as+last+time&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=">existing bug</a> or if one does not exist, 
 			<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=ksebasti%40redhat.com&amp;blocked=&amp;bug_file_loc=http%3A%2F%2F&amp;bug_severity=normal&amp;bug_status=NEW&amp;comment=&amp;component=OProfile&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=&amp;version=0.2">file a new bug</a>.
 		</p>
-		<h2 id="Rebuilding_opxml">Rebuilding opxml</h2>
+		<h2 id="Rebuilding_opxml_.28Deprecated.29">Rebuilding opxml (Deprecated)</h2>
+		<p>
+			<b>NOTE: As of Linux Tools version 0.7.0 opxml is NOT required anymore.</b>
+		</p>
 		<p>You will need to rebuild the <code>opxml</code> binary if running it returns an error similar to the following:</p>
-		<dl>
-			<dd><code>opxml: /some/path/libc.so.6: version `GLIBC_2.8' not found (required by opxml)</code></dd>
-		</dl>
+		<pre> opxml: /some/path/libc.so.6: version `GLIBC_2.8' not found (required by opxml)
+</pre>
 		<p>
 			<b>Warning:</b> this is rarely necessary; in some cases, rebuilding the <code>opxml</code> binary may break an otherwise working OProfile plug-in installation. You should only rebuild the <code>opxml</code> binary if you are sure that doing so is the only remaining option in fixing the OProfile plug-in for Eclipse.
 		</p>
@@ -245,7 +244,7 @@ fi
 			</li>
 		</ol>
 		<p>The required libraries should now be in the proper place for compiling. Continue the steps in the 
-			<a href="Troubleshooting.html#Rebuilding_opxml">Rebuilding opxml</a> section.
+			<a href="#Rebuilding_opxml_(Deprecated)">Rebuilding opxml</a> section.
 		</p>
 		<p>
 			<b>Note:</b> The procedure for building the OProfile development libraries for Ubuntu (described in this section) was tested on Ubuntu 10.04 with Eclipse, the CDT, oprofile and all its dependencies already installed via <code>apt</code>.
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/User-Guide.html b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/User-Guide.html
index 4374402b1f..1cbf36420d 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/User-Guide.html
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/Linux_Tools_Project/OProfile/User_Guide/User-Guide.html
@@ -25,7 +25,6 @@
 				<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>OProfile is a system-wide Linux profiler, capable of running at low overhead. It consists of a kernel driver and a daemon for collecting raw sample data, along with a suite of tools for parsing that data into meaningful information. OProfile is generally used by developers to determine which sections of code consume the most amount of CPU time, and why.</p>
 		<p>The OProfile plug-in allows Eclipse users to seamlessly include OProfile capabilities into their development workflow, regardless of their experience in using OProfile. Users with little experience in OProfile can use the 
diff --git a/oprofile/org.eclipse.linuxtools.oprofile.doc/toc.xml b/oprofile/org.eclipse.linuxtools.oprofile.doc/toc.xml
index 6b8b71ce79..7cee287f7a 100644
--- a/oprofile/org.eclipse.linuxtools.oprofile.doc/toc.xml
+++ b/oprofile/org.eclipse.linuxtools.oprofile.doc/toc.xml
@@ -34,12 +34,12 @@
 				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Error:_required_binaries_do_not_exist.2C_OProfile_not_installed.3F" label="Error: required binaries do not exist, OProfile not installed?"></topic>
 				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Error:_.2Fusr.2Fbin.2Fconsolehelper_does_not_exist.2C_run_install-noconsolehelper.sh_instead" label="Error: /usr/bin/consolehelper does not exist, run install-noconsolehelper.sh instead"></topic>
 				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Error:_cannot_create_opcontrol_wrapper_in_.3Cdirectory.3E" label="Error: cannot create opcontrol wrapper in &lt;directory&quot;"></topic>
-				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Error:_cannot_find_opxml_binary.2C_required_plugin_missing" label="Error: cannot find opxml binary, required plugin missing"></topic>
+				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Error:_cannot_find_opxml_binary.2C_required_plugin_missing_.28Deprecated.29" label="Error: cannot find opxml binary, required plugin missing (Deprecated)"></topic>
 			</topic>
 			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#No_Samples_From_A_Profile" label="No Samples From A Profile"></topic>
 			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Log_Reader_Hangs" label="Log Reader Hangs"></topic>
-			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Errors_Related_to_opxml" label="Errors Related to opxml"></topic>
-			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Rebuilding_opxml" label="Rebuilding opxml">
+			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Errors_Related_to_opxml_.28Deprecated.29" label="Errors Related to opxml (Deprecated)"></topic>
+			<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Rebuilding_opxml_.28Deprecated.29" label="Rebuilding opxml (Deprecated)">
 				<topic href="Linux_Tools_Project/OProfile/User_Guide/Troubleshooting.html#Ubuntu_-_Extra_Requirements" label="Ubuntu - Extra Requirements"></topic>
 			</topic>
 		</topic>