Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 396272 - Javadoc generation broken (links cannot be resolved)
Summary: Javadoc generation broken (links cannot be resolved)
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 4.3   Edit
Hardware: All All
: P3 major (vote)
Target Milestone: 4.3 M4   Edit
Assignee: Paul Webster CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-12-11 08:53 EST by Dani Megert CLA
Modified: 2012-12-12 03:44 EST (History)
2 users (show)

See Also:

Attachments
4.3 replace.patch (6.96 KB, patch)
2012-12-11 09:47 EST, Thanh Ha CLA 		no flags Details | Diff
4.3 replace.patch v2 (7.53 KB, patch)
2012-12-11 10:04 EST, Thanh Ha CLA 		no flags Details | Diff
4.3 replace.patch v3 (7.80 KB, patch)
2012-12-11 10:38 EST, Thanh Ha CLA 		no flags Details | Diff
3.8 replace.patch (8.59 KB, patch)
2012-12-11 11:27 EST, Thanh Ha 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 Dani Megert CLA 2012-12-11 08:53:45 EST 
Started with I20121210-2000. Also broken in last M-build.

http://download.eclipse.org/eclipse/downloads/drops4/I20121210-2000/logs.php#javadoc 

One can see it in the UI by looking at the Javadoc (e.g. IOpenable (in JDT Core: IProgressMonitor is not shown as link).
Comment 2 Thanh Ha CLA 2012-12-11 09:47:38 EST 
Created attachment 224564 [details]
4.3 replace.patch

I suspect this is due to missing replacement strings in buildDoc.xml. Attached patch adds the missing ones for 4.3.
Comment 3 Thanh Ha CLA 2012-12-11 10:04:14 EST 
Created attachment 224565 [details]
4.3 replace.patch v2

There was a mistake in the previous patch where @eclipse.platform.ui@ should have been @eclipse.platform.ui.bundles@
Comment 4 Paul Webster CLA 2012-12-11 10:09:00 EST 
(In reply to comment #3)
> Created attachment 224565 [details]
> 4.3 replace.patch v2

With the platform.doc.isv changes the size of the log goes from 45KB to 0.  I'll test jdt and pde as well to confirm.

PW
Comment 5 Thanh Ha CLA 2012-12-11 10:38:49 EST 
Created attachment 224572 [details]
4.3 replace.patch v3
Comment 6 Paul Webster CLA 2012-12-11 10:52:41 EST 
I've release this to master as http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=c51cbd5ec7e05e11e989970e67177e329478e2b5

I've also cherry-picked it to 4.2.2.  Thanh, could you confirm that 4.2.2 is correct as well, and I'll cherry-pick it to 3.8.2

PW
Comment 7 Paul Webster CLA 2012-12-11 10:53:21 EST 
I tested this by making the changes in place in last night's I build working directory, and re-running the buildDoc.  The errors from the logs are fixed.

PW
Comment 8 Thanh Ha CLA 2012-12-11 10:56:45 EST 
(In reply to comment #6)
> I've also cherry-picked it to 4.2.2.  Thanh, could you confirm that 4.2.2 is
> correct as well, and I'll cherry-pick it to 3.8.2

4.2.2 and master are the same but I believe 3.8.2 will need a separate patch
Comment 9 Thanh Ha CLA 2012-12-11 11:27:40 EST 
Created attachment 224580 [details]
3.8 replace.patch

Attached patch is adapted for 3.8 branch.
Comment 11 David Williams CLA 2012-12-11 21:52:32 EST 
I still see "samples doc" errors in build log. I've opened bug 396368 to cover that specifically ... might be related to this bug ... but, slightly different.
Comment 12 Dani Megert CLA 2012-12-12 03:44:42 EST 
Verified in I20121211-2000 that
1) no Javadoc problems are logged
2) the links in Help's API Reference doc work again