Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "PDE/API Tools/Migration IDE Integration"
(New page: Integration of Use and Migration Scans {bug|310547} The 3.6 API tools have support for usage scanning - allowing adopters to provide scans back to you on what API and internal code they'r...) |
|||
| Line 1: | Line 1: | ||
| − | Integration of Use and Migration Scans | + | {{bug2|Integration of Use and Migration Scans|310547}} |
| − | + | ||
The 3.6 API tools have support for usage scanning - allowing adopters to | The 3.6 API tools have support for usage scanning - allowing adopters to | ||
| − | provide scans back to you on what API and internal code they're using. | + | provide scans back to you on what API and internal code they're using. The tooling |
| − | + | is ant task based. What we want is integration into the IDE so a scan can be loaded and | |
| − | + | any breaking changes will be marked as problems in the editor. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | the | + | |
| − | + | ||
| − | + | ||
= Main Components = | = Main Components = | ||
| − | == UI for managing scans == | + | === UI for managing scans === |
| − | + | * Preference page | |
| − | == Backend for managing scans == | + | === Backend for managing scans === |
| − | + | * Store in metadata? | |
| − | + | * Needs to be more efficient than separate xml files | |
| − | == Incremental Builder == | + | === Incremental Builder === |
| − | + | * Add to the existing API Tooling incremental builder | |
| − | + | * Compare current type against use scan and return breakage | |
| − | == Marker Management == | + | === Marker Management === |
| − | + | * Create markers for usage breaking changes | |
| − | + | * Clean stale markers when content or use scans change | |
| − | + | * Needs new error level settings | |
| − | == Performance == | + | === Performance === |
| − | + | * Must have no impact when off (check error level settings at start) | |
| − | + | * Use LRU caches as scan cannot be loaded into memory | |
| − | + | * Full builds must be possible | |
| − | == Tests == | + | === Tests === |
| − | + | * Complete test suite for incremental builder | |
| − | + | * Enhance the performance tests | |
= Additional Enhancements = | = Additional Enhancements = | ||
| − | == Annotate method/type usage in editors == | + | === Annotate method/type usage in editors === |
| − | + | * When editor is open, methods/types being used are annotated | |
| − | == Support multiple scans == | + | === Support multiple scans === |
| − | + | * Compare against all of them | |
| − | == Use Scan Updating == | + | === Use Scan Updating === |
| − | + | * Support for recognizing when a newer use scan is available | |
Revision as of 13:03, 27 September 2010
The 3.6 API tools have support for usage scanning - allowing adopters to
provide scans back to you on what API and internal code they're using. The tooling
is ant task based. What we want is integration into the IDE so a scan can be loaded and
any breaking changes will be marked as problems in the editor.
Contents
Main Components
UI for managing scans
- Preference page
Backend for managing scans
- Store in metadata?
- Needs to be more efficient than separate xml files
Incremental Builder
- Add to the existing API Tooling incremental builder
- Compare current type against use scan and return breakage
Marker Management
- Create markers for usage breaking changes
- Clean stale markers when content or use scans change
- Needs new error level settings
Performance
- Must have no impact when off (check error level settings at start)
- Use LRU caches as scan cannot be loaded into memory
- Full builds must be possible
Tests
- Complete test suite for incremental builder
- Enhance the performance tests
Additional Enhancements
Annotate method/type usage in editors
- When editor is open, methods/types being used are annotated
Support multiple scans
- Compare against all of them
Use Scan Updating
- Support for recognizing when a newer use scan is available