Bug 570430 - Add javadoc checks to gerrit verification
Summary: Add javadoc checks to gerrit verification
Status: NEW
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 4.14   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Platform-Releng-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-01-18 02:04 EST by Christoph Laeubrich CLA
Modified: 2022-01-31 13:35 EST (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Christoph Laeubrich CLA 2021-01-18 02:04:55 EST
Recently a problem in the regular build regarding javadoc occurs [1] but the gerrit verification succeeds without a problem.

The expectation would be that if the gerrit verification build passes that also the regular build passes (except for very rare circumstances).

To archive this, the gerrit verification build should check for javadoc errors also.

[1] Bug 570429
Comment 1 Mickael Istria CLA 2021-01-18 02:17:34 EST
@Sravan: How is the Javadoc check performed?

As a preliminary step, I tried to just configure the IDE so that is would show a warning or an error here; but didn't manage to get the error reported in here.
Comment 2 Sravan Kumar Lakkimsetti CLA 2021-01-18 03:10:41 EST
(In reply to Mickael Istria from comment #1)
> @Sravan: How is the Javadoc check performed?
> 
> As a preliminary step, I tried to just configure the IDE so that is would
> show a warning or an error here; but didn't manage to get the error reported
> in here.

Javadoc is built using bundles from eclipse.platform.common. We use javadoc executable with the the options listed here https://git.eclipse.org/c/platform/eclipse.platform.common.git/tree/bundles/org.eclipse.platform.doc.isv/platformOptions.txt

here is the ant file that is used building javadoc. https://git.eclipse.org/c/platform/eclipse.platform.common.git/tree/bundles/org.eclipse.platform.doc.isv/buildDoc.xml

I guess this would be a starting point.