blob: 1f481a90a51c7620a884aba64366a95676b030eb [file] [log] [blame]
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="../wtp.xsl"?>
<html>
<head>
<meta name="root" content="../../" />
<title>web tools platform adopters</title>
</head>
<body>
<h1>WTP Usage Scanner</h1>
<h2>How to generate a usage report of WTP code</h2>
<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>
<h2>How to check for API and non-API breakages</h2>
<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>
</body>
</html>