Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 326559 - Update user Ant task documentation for include lists
Summary: Update user Ant task documentation for include lists
Status: VERIFIED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: API Tools (show other bugs)
Version: 3.7   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.7 M3   Edit
Assignee: Darin Wright CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-09-29 12:32 EDT by Darin Wright CLA
Modified: 2010-10-27 12:55 EDT (History)
1 user (show)

See Also:

Attachments
Doc Patch (17.24 KB, patch)
2010-10-04 06:16 EDT, Ankur Sharma CLA 		no flags Details | Diff
updated patch (21.75 KB, patch)
2010-10-04 12:01 EDT, Darin Wright CLA 		no flags Details | Diff
Better fix (32.75 KB, patch)
2010-10-26 13:44 EDT, Curtis Windatt CLA 		no flags Details | Diff
Show Obsolete (2) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Darin Wright CLA 2010-09-29 12:32:17 EDT 
Support has been added to all API tools Ant tasks to support include lists (see bug 270973). The user documentation needs to be updated to reflect this for each ant task in the following folder.

/org.eclipse.pde.doc.user/reference/api-tooling/ant-tasks
Comment 1 Ankur Sharma CLA 2010-10-04 06:16:59 EDT 
Created attachment 180144 [details]
Doc Patch
Comment 2 Darin Wright CLA 2010-10-04 12:01:37 EDT 
Created attachment 180180 [details]
updated patch

I updated the include/exclude "template" to add more explanation. However, I noticed that the freeze report allows the list to specify members as well as bundles. The doc does not describe this, or which tasks support members vs. bundles in the include/exclude lists.
Comment 3 Darin Wright CLA 2010-10-05 11:23:00 EDT 
Summary of what the different tasks support for filters:

API Tools Analysis Task:    bundles
API Freeze Task:            members
API Deprecation Task:       members
API Use Report Task:        bundles
API Migration Task:         bundles
API Compare Task:           bundles
Comment 4 Curtis Windatt CLA 2010-10-26 13:44:45 EDT 
Created attachment 181750 [details]
Better fix

Takes Ankur/Darin's work and finishes up the bundles/members issues from comment #3.  Also adds in documentation for the consumer report conversion task.
Comment 5 Curtis Windatt CLA 2010-10-26 13:47:32 EDT 
I have applied everything except the two minor javadoc changes to HEAD (I don't have commit rights to api tooling :)

Sending the bug Darin's way so he can commit them.
Comment 6 Darin Wright CLA 2010-10-26 14:34:32 EDT 
Fixed. Added the new task to the reference TOC as well.
Comment 7 Curtis Windatt CLA 2010-10-27 12:55:09 EDT 
Verified in I20101027-0800