Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 379431

Summary: [Releng] documentation missing in Tools build
Product: [RT] RAP Reporter: Markus Knauer <mknauer>
Component: RelengAssignee: Project Inbox <rap-inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P1    
Version: unspecified   
Target Milestone: 1.5 RC2   
Hardware: PC   
OS: Linux   
Whiteboard:

Description Markus Knauer CLA 2012-05-14 10:47:41 EDT
During our update of the Tools build to Git we found a dependency to the main RAP Runtime repository. 

The documentation that is included in the Tools bundle org.eclipse.rap.help is generated from multiple bundles (org.eclipse.rap.ui, org.eclipse.rwt.*, org.eclipse.rap.rwt) that are available in the main RAP Git repository only - see build script in /org.eclipse.rap.tools.releng/reference/build.xml.

As a quick workaround the creation of the help is currently disabled in /org.eclipse.rap.tools.releng/scripts/tooling-build.sh
Comment 1 Ralf Sternberg CLA 2012-05-14 11:13:06 EDT
Moreover, the TOC of the reference seems to be hardcoded. Some packages are missing from the JavaDoc.
Comment 2 Markus Knauer CLA 2012-05-15 04:54:26 EDT
I would propose to solve this in the meantime by

(a) add the runtime Git repository to the tools build and update the paths to the bundles mentioned above and
(b) leave this bug open until we have a clean solution.

A clean solution could be one that consumes the exact output of a certain runtime build, or better, to create this part of the help somewhere in the runtime build. But for the time being I think it is important to get to the old status quo before the migration as soon as possible. Any objections or better proposals?
Comment 3 Markus Knauer CLA 2012-05-16 06:22:48 EDT
Implemented as proposed in comment #2 in commit aac2892fd37e0810bc4d5f2f109d8c0d52547da5 and (signed) build 459 verified.
I'll leave this bug open because the issue mentioned in comment #1 still needs to be addressed.
Comment 4 Ralf Sternberg CLA 2012-05-25 05:02:46 EDT
I've manually updated the toc.xml for 1.5 (commit 18b62f9bbcdc74dabeb1198a8ae4e0b5dacfe21e) and master (commit 830fdddfa7ef9ce902032727adfaf88a9059cb57).

For the hard coded toc entries I've opened bug 380626.