blob: 6dfa53693da0a39bd605869fccb410844bf63137 [file] [log] [blame]
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="../..//default_style.css" type="text/css">
<link rel="stylesheet" href="../..//webtools/wtp.css" type="text/css">
<title>web tools platform adopters</title>
</head>
<body>
<table width="100%" cellspacing="5" cellpadding="2" border="0">
<tbody>
<tr>
<td width="60%" align="left"><font class="indextop">WTP Usage Scanner</font>
<br>
<font class="indexsub">web tools platform adopters</font></td><td width="40%"><img width="207" hspace="50" height="129" align="middle" src="../..//webtools/images/wtplogosmall.jpg"></td>
</tr>
</tbody>
</table>
<table width="100%" cellspacing="5" cellpadding="2" border="0">
<col width="16">
<col width="*">
<tbody>
<tr>
<td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">How to generate a usage report of WTP code</font></b></td>
</tr>
<tr>
<td valign="top" align="right">&nbsp;</td><td valign="top">
<p>
<ol>
<li>
Download the <a href="http://www.eclipse.org/downloads/download.php?file=/webtools/downloads/wtp-apiscanner.zip">Eclipse API scanner</a> and unzip it on top of your Eclipse driver.
</li>
<li>
Start Eclipse.
</li>
<li>
Launch org.eclipse.wtp.releng.tools.component.adopters.SimpleClass2Reference as an Eclipse application. See figure below.
<p>
<img src="img/figure2.gif"></p>
</li>
<li>
Provide the following VM arguments:
<p>
<pre>
-Dsrc=D:\temp\MyProduct.zip
-Dbase=D:\temp\wtp-sdk-1.5M4.zip
-Doutput=D:\temp\usage\wtp-usage.xml
-Dincludes=org.eclipse.wst.*,org.eclipse.jst.*,org.eclipse.jem*,org.eclipse.jpt*
-DcontactInfo=your_email@your_business.com
-Dhtml=D:\temp\usage\wtp-usage.html
</pre>
</p>
</li>
<li>
Click run. Below is a sample WTP usage report.
<p>
<img src="img/figure3.gif"></p>
</li>
</ol>
</p>
</td>
</tr>
<tr>
<td valign="top" bgcolor="#0080c0" align="left" colspan="2"><b><font face="Arial,Helvetica" color="#ffffff">How to check for API and non-API breakages</font></b></td>
</tr>
<tr>
<td valign="top" align="right">&nbsp;</td><td valign="top">
<p>
<ol>
<li>
Check out the org.eclipse.wtp.releng.tools.component.core plugin from CVS if you have not already done so.
Lauch org.eclipse.wtp.releng.tools.component.adopters.APIRefCompatibilityScanner as an Eclipse application. See figure below.
<p>
<img src="img/figure4.gif"></p>
</li>
<li>
Provide the following VM arguments:
<p>
<pre>
-Dsrc=D:\temp\wtp-sdk-1.5M4.zip -Duse=D:\temp\usage -DoutputDir=D:\temp\output
</pre>
</p>
</li>
<li>
Click run. The sample report below shows you the classes/methods/fields that were removed.
<p>
<img src="img/figure5.gif"></p>
</li>
</ol>
</p>
</td>
</tr>
</tbody>
</table>
</body>
</html>