forked from windup/windup-eclipse-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
windup.html
190 lines (183 loc) · 7.71 KB
/
windup.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<!DOCTYPE html>
<html>
<head>
<style type="text/css">
body {
font-family: Arial,helvetica,sans-serif;
}
</style>
</head>
<body>
</body>
<h2>Getting Started</h2>
<h3>Identify and Resolve Migration Issues</h3>
<div>
<p>
Analyze your project to identify and fix migration issues.
</p>
<ol>
<li>
Import the project to analyze.
</li>
<li>
<p>
<a href="#create-config">Create a run configuration</a>. From the Issue Explorer, press the New Configuration button (<img src="../icons/windup.png"/>).
</p>
<p>
<img src="../images/windup_button_create_config.png"/>
</p>
<p>
At a minimum, select the project to analyze. Set additional options as needed.
</p>
</li>
<li>
<p>
Click <b>Run</b> to <a href="#execute-windup">execute the analysis</a>.
</p>
</li>
<li>
<p>
<a href="#review-issues">Review identified issues</a> listed in the Issue Explorer.
</p>
</li>
<li>
<p>
<a href="#resolve-issues">Resolve identified issues</a> by manually updating code or by using quick fixes when available.
</p>
</li>
<li>
<p>
Run the analysis again as necessary. Use the drop down next to the Run button (<img src="../icons/run_exc.png"/>) to run an existing configuration.
</p>
</li>
</ol>
</div>
<a name="create-config"><h3>Create a new Run Configuration</h3></a>
<div>
<p>
A run configuration can be created using the New Configuration button (<img src="../icons/windup.png"/>). You can create multiple run configurations, each with a unique name.
</p>
<h4>Input</h4>
<p>
Select a <b>migration path</b>. This determines which rulesets are used. The migration path defaults to <b>Anything to EAP 7</b>, but can be changed to any supported migration path.
</p>
<p>
Select one or more <b>projects</b> to analyze. Hold the <b>Ctrl</b> key to select multiple projects in the list.
</p>
<p>
Select one or more <b>packages</b> to scan. It is recommended to select only those packages that you need to analyze to reduce the overall execution time. If no packages are selected, all packages in the project will be scanned. Hold the <b>Ctrl</b> key to select multiple packages in the list.
</p>
<h4>Options</h4>
<p>
Generate a report. Check the <b>Generate Report</b> checkbox if you want to generate the HTML report. The report will be shown in the <b>Report</b> tab and can be found in the Issue Explorer when you group by <b>File</b>.
</p>
<p>
Set additional <b>options</b>. Any option that is a boolean flag, such as <b>enableTattletale</b>, should enter <b>true</b> as the value.
</p>
<h4>Rules</h4>
<p>
Add a <b>custom rules directory</b> if you have any custom rules.
</p>
</div>
<a name="execute-windup"><h3>Execute Analysis</h3></a>
<div>
<p>
Once a run configuration has been created, you can run the analysis using the configuration in one of the following ways:
</p>
<ul>
<li>
Select the run configuration from the <b>Run Configurations</b> dialog and click <b>Run</b>.
</li>
<li>
Select a recent run configuration from the drop down next to the <b>Run</b> button (<img src="../icons/run_exc.png"/>).
</li>
</ul>
<p>
If Windup is not currently running, it will start once a run configuration is executed. If you do not plan on analyzing again in the near future, it is recommended to stop the Windup to conserve memory on your machine.
</p>
</div>
<a name="review-issues"><h3>Review Issues</h3></a>
<div>
<p>
Use the Issue Explorer to review migration issues identified by the analysis. Different <a href="#icon-legend">icons</a> indicate the issue's severity and state.
</p>
<p>
Change how issues are grouped by adjusting the <b>Group By</b> selections: Severity, Migration Rule, File.
</p>
<p>
<img src="../images/windup_group_by.png"/>
</p>
<p>
Double-click the issue in the Issue Explorer to open the associated line of code in an editor. Right-click and select <b>Issue Details</b> to view information about the issue, including its severity and how to address it.
</p>
</div>
<a name="resolve-issues"><h3>Resolve Issues</h3></a>
<div>
<p>
You can resolve issues by updating the code manually or by applying a quick fix when available.
</p>
<h4>Manual Update</h4>
<p>
Review the issue details and additional resources and update the source code as necessary. When you update a line of code marked as an issue, the issue will be marked with the stale icon (<img src="../icons/stale_issue.gif"/>) until the next time the project is analyzed.
</p>
<p>
You can also manually mark an issue as fixed, which will mark the issue with the resolved icon (<img src="../icons/fixedIssue.gif"/>) until the next time the project is analyzed. To mark an issue as fixed, right-click the issue in the Issue Explorer and select <b>Mark as Fixed</b>.
</p>
<h4>Quick Fix</h4>
<p>
Some issues provide a quick fix, which assists in making the necessary edits to address the issue.
</p>
<h5>Preview a Quick Fix</h5>
<p>
Right-click the issue and select <b>Preview Quick Fix</b>. This will bring up a window that allows you to preview the change. From here, you can apply the fix or close the window.
</p>
<h5>Apply a Quick Fix</h5>
<p>
Right-click the issue and select <b>Apply Quick Fix</b>. This will update the source code as required and will mark the issue as resolved.
</p>
</div>
<a name="icon-legend"><h3>Issue Legend</h3></a>
<div>
<p>
In the Issue Explorer and file editors, issues use an icon to indicate their severity level and status. The following table describes the meaning of the various icons.
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Icon</th>
<th>Description</th>
</tr>
<tr>
<td><img src="../icons/error.png"/></td>
<td>The issue is mandatory to fix for a successful migration.
</tr>
<tr>
<td><img src="../icons/info.gif"/></td>
<td>The issue is optional to fix for migration.
</tr>
<tr>
<td><img src="../icons/warning.png"/></td>
<td>The issue may potentially be an issue during migration.</td>
</tr>
<tr>
<td><img src="../icons/fixedIssue.gif"/></td>
<td>The issue has been resolved.</td>
</tr>
<tr>
<td><img src="../icons/stale_issue.gif"/></td>
<td>The issue is stale because the code marked as an issue has been modified since the last time the project was analyzed.</td>
</tr>
<tr>
<td><img src="../icons/quickfix_error.png"/></td>
<td>A quick fix is available for this issue, which is mandatory to fix for a successful migration.</td>
</tr>
<tr>
<td><img src="../icons/quickfix_info.png"/></td>
<td>A quick fix is available for this issue, which is optional to fix for migration.</td>
</tr>
<tr>
<td><img src="../icons/quickfix_warning.png"/></td>
<td>A quick fix is available for this issue, which may potentially be an issue during migration.</td>
</tr>
</table>
</div>
</html>