Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 315280 - JSDT doc bundle is out of date
Summary: JSDT doc bundle is out of date
Status: RESOLVED FIXED
Alias: None
Product: JSDT
Classification: WebTools
Component: Debug (show other bugs)
Version: 3.2   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.2 RC4   Edit
Assignee: Michael Rennie CLA
QA Contact: Simon Kaegi CLA
URL:
Whiteboard: PMC_approved
Keywords:
Depends on:
Blocks: 314796 314797
  Show dependency tree
 
Reported: 2010-06-01 15:16 EDT by Michael Rennie CLA
Modified: 2010-06-03 13:42 EDT (History)
5 users (show)

See Also:
david_williams: pmc_approved+
raghunathan.srinivasan: pmc_approved+
david_williams: pmc_approved? (naci.dai)
david_williams: pmc_approved? (deboer)
neil.hauge: pmc_approved+
david_williams: pmc_approved? (kaloyan)
simon_kaegi: review+


Attachments
wip (10.12 KB, patch)
2010-06-01 15:16 EDT, Michael Rennie CLA
no flags Details | Diff
wip2 (11.54 KB, patch)
2010-06-01 16:20 EDT, Michael Rennie CLA
no flags Details | Diff
wip3 (38.06 KB, patch)
2010-06-01 16:58 EDT, Michael Rennie CLA
no flags Details | Diff
fix (65.34 KB, patch)
2010-06-02 12:14 EDT, Michael Rennie CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Rennie CLA 2010-06-01 15:16:32 EDT
Created attachment 170682 [details]
wip

Our doc bundle is a manual effort that should not have to be. The bundle should be updated to use the new ( since 2002) Ant callbacks to build the doc, etc for us - like JDT, PDE, and the Platform does.

It has been a long time since I had to update a doc bundle, but this *should* work. I am testing it now, so I won't promise the patch works....
Comment 1 Michael Rennie CLA 2010-06-01 16:20:46 EDT
Created attachment 170696 [details]
wip2

The other patch ommitted 90% of the API bundles by accident...this patch fixes that and the typo.
Comment 2 Michael Rennie CLA 2010-06-01 16:58:20 EDT
Created attachment 170704 [details]
wip3

This patch includes all of the changes to the build.properties, etc for the updated Ant task. The patch does not include the removal of the now uneeded /html directory, nor does it include the new API doc in /reference/api.
Comment 3 Michael Rennie CLA 2010-06-02 12:14:35 EDT
Created attachment 170828 [details]
fix

This patch is a rool-up of all changes to the doc bundle to "modernize" it including:

1. all TOC updates
2. build callback hook to auto gen the javadoc + extension doc
3. removal of outdated + unused files
4. re-organization of topics

The patch does not include the removal of the old /html dir - which contained a tonne of out-dated javadoc - because it makes the patch 28.8MB with that removal
Comment 4 David Williams CLA 2010-06-02 13:24:30 EDT
I've discussed with Michael, and asked him to release these doc-only changes for this week's RC4 candidate, without necessarily waiting for 3 votes, since it is only doc changes ... and we are close to deadline. Naturally, other PMC members can "vote no" if you disagree. 

Thanks,
Comment 5 Simon Kaegi CLA 2010-06-02 13:30:17 EDT
Huge +1 on this. Thank-you Michael.
I think it would be good to get a Hudson build rolling on this.
Comment 6 Michael Rennie CLA 2010-06-02 14:16:33 EDT
applied patch + removal of huge /html folder. The patch contains the fix to bug
314797 as well