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

Bug 339076

Summary:	[releng] Avoid creating javadoc with every build
Product:	[Modeling] OCL	Reporter:	Adolfo Sanchez-Barbudo Herrera <adolfosbh>
Component:	Core	Assignee:	Adolfo Sanchez-Barbudo Herrera <adolfosbh>
Status:	CLOSED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	eclipse, sbouchet
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description Adolfo Sanchez-Barbudo Herrera

2011-03-07 06:54:45 EST

Creating javadoc during the builds consumes time and server resources. Giving that we are not shipping javadoc into the doc plugins, we coud avaoid creating javadoc with every build.

Some alternatives (without too much time thinking on them ;P):
a) Having an specific job which would create and publish the javadoc
b) Trying to make the current javadoc creation and publication configurable with a hudson job parameter
c) No creating javadoc in builds. We could manually call and ant task to do that when required.

Comment 1 Adolfo Sanchez-Barbudo Herrera

2011-03-11 06:28:40 EST

I've chosen alternative b). Now the javadoc is not built by default. In scheduled builds (Milestones, Releases) we could check the javadoc creation  to update itwhen launching the build .

Steps taken, for any other interested releng:

1. Create a new booelan MANAGE_JAVADOC parameter in hudson's job (unchecked by default :) )
2. Pre-buckminster commands  (done in job configuration). Append a new create.javadoc=${MANAGE_JAVADOC} entry in the build.properties file.
3. Modifications to buckminster.cspec file (Compare 1.25 - 1.23 CVS versions).
4. Modifications to javadoc.ant file (Compare 1.9 - 1.5 CVS versions).
5. Modifications to promoter.ant file (Compare 1.15 -1.9 CVS versions).
6. Post-buckminster commands (done in job configuration). Make the moving of javadoc depend on MANAGE_JAVADOC parameter value:
if [ ${MANAGE_JAVADOC} = "true" ]
then
  mkdir MDT-OCL.javadoc
  mv buildroot/buckminster.output/org.eclipse.ocl.releng.buckminster_*-buckminster/javadoc/MDT-OCL-javadoc.zip MDT-OCL.javadoc/MDT-OCL-javadoc.zip
  rm -rf buildroot/buckminster.output/org.eclipse.ocl.releng.buckminster_*-buckminster/javadoc
fi

I've been doing some tests during yesterday and today, and it looks like it's properly working (both, creation and publishing).

Resolving as fixed.

Comment 2 Axel Uhl

2011-04-12 18:31:10 EDT

As discussed on the mailing list, I'll re-open this one because of the broken relative Javadoc links that no longer work in the online help.

Comment 3 Adolfo Sanchez-Barbudo Herrera

2011-04-13 04:26:00 EDT

Actually, the bugzilla affected by the discussed problem is the https://bugs.eclipse.org/bugs/show_bug.cgi?id=337202 one, because it's a Help's issue rather than a javadoc one.

Closing this bugzilla as fixed.

Comment 4 Ed Willink

2011-05-27 03:14:04 EDT

Closing