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

Bug 464172

Summary: Reduce the number of warnings for org.osgi.* classes by using the "Ignore optional compile problems" option
Product: [Eclipse Project] Equinox Reporter: Szymon Ptaszkiewicz <sptaszkiewicz>
Component: ComponentsAssignee: Szymon Ptaszkiewicz <sptaszkiewicz>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: daniel_megert, david_williams, markus.kell.r, tjwatson
Version: 4.5.0 Mars   
Target Milestone: Mars M7   
Hardware: All   
OS: All   
See Also: https://git.eclipse.org/r/45476
https://git.eclipse.org/r/45478
https://git.eclipse.org/r/45479
https://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=71f623df7e43d2f54864d17c692475dcae3ba21d
https://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=514d2bc398399f0d61cbbc577aa0bec83591c7a0
https://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=d5ecf18441b571691f7d9b6f22e4019e29962742
https://git.eclipse.org/r/45668
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4a193a7354c18fcb37258ba43dd7672eac9a7a70
Whiteboard:
Bug Depends on:    
Bug Blocks: 507055    

Description Szymon Ptaszkiewicz CLA 2015-04-08 10:59:27 EDT
Similar to bug 463706 but for projects in the rt.equinox.bundles repo.

We can significantly reduce the number of warnings produced by the org.osgi.* classes by enabling the "Ignore optional compile problems" option for the source folder which contains them. This would remove all warnings that are produced by the Java builder without reducing the verbosity of the compiler for other source folders in this project. Patches will follow, I will push one change per project to make it easier to review/manage it.
Comment 1 Eclipse Genie CLA 2015-04-08 11:18:06 EDT
New Gerrit change created: https://git.eclipse.org/r/45476
Comment 2 Eclipse Genie CLA 2015-04-08 11:31:44 EDT
New Gerrit change created: https://git.eclipse.org/r/45478
Comment 3 Eclipse Genie CLA 2015-04-08 12:00:47 EDT
New Gerrit change created: https://git.eclipse.org/r/45479
Comment 4 Szymon Ptaszkiewicz CLA 2015-04-08 12:08:02 EDT
There are also some OSGi classes in the org.eclipse.equinox.preferences project but they do not produce any warnings so I didn't change it for the time being. In the long term, it may be a good idea to move them to a separate source folder as well.
Comment 8 Thomas Watson CLA 2015-04-09 08:39:43 EDT
Thanks again!
Comment 9 Markus Keller CLA 2015-04-10 08:23:48 EDT
When you touch source folders or add/remove packages or dependencies, you also have to update Javadoc generation:
https://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc

Problems in N-build: http://download.eclipse.org/eclipse/downloads/drops4/N20150409-2000/compilelogs/platform.doc.isv.javadoc.txt
Comment 10 Thomas Watson CLA 2015-04-10 08:28:03 EDT
(In reply to Markus Keller from comment #9)
> When you touch source folders or add/remove packages or dependencies, you
> also have to update Javadoc generation:
> https://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc
> 
> Problems in N-build:
> http://download.eclipse.org/eclipse/downloads/drops4/N20150409-2000/
> compilelogs/platform.doc.isv.javadoc.txt

Szymon, will you handle that?
Comment 11 Szymon Ptaszkiewicz CLA 2015-04-10 09:00:39 EDT
(In reply to Thomas Watson from comment #10)
> (In reply to Markus Keller from comment #9)
> > When you touch source folders or add/remove packages or dependencies, you
> > also have to update Javadoc generation:
> > https://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc
> > 
> > Problems in N-build:
> > http://download.eclipse.org/eclipse/downloads/drops4/N20150409-2000/
> > compilelogs/platform.doc.isv.javadoc.txt
> 
> Szymon, will you handle that?

Yes, I will fix it.
Comment 12 Eclipse Genie CLA 2015-04-10 12:05:09 EDT
New Gerrit change created: https://git.eclipse.org/r/45668
Comment 13 Szymon Ptaszkiewicz CLA 2015-04-10 12:11:52 EDT
(In reply to Eclipse Genie from comment #12)
> New Gerrit change created: https://git.eclipse.org/r/45668

I pushed a change that adds org.eclipse.equinox.app/osgi as a new source folder. I didn't add other source folders that were created because they were not mentioned in the log as problematic. Should they be added as well even if javadoc log does not complain about them?
Comment 14 Szymon Ptaszkiewicz CLA 2015-04-10 12:24:34 EDT
(In reply to Szymon Ptaszkiewicz from comment #13)
> (In reply to Eclipse Genie from comment #12)
> > New Gerrit change created: https://git.eclipse.org/r/45668
> 
> I pushed a change that adds org.eclipse.equinox.app/osgi as a new source
> folder. I didn't add other source folders that were created because they
> were not mentioned in the log as problematic. Should they be added as well
> even if javadoc log does not complain about them?

I had a chat with Tom about that and we agreed that we should add only source folders for those projects that had already its source folder mentioned earlier which means only the entry for org.eclipse.equinox.app/osgi was missing.
Comment 16 Szymon Ptaszkiewicz CLA 2015-04-10 12:28:18 EDT
Marking fixed. I will keep an eye on today's N-build to verify javadoc is happy.
Comment 17 Markus Keller CLA 2015-04-10 13:03:22 EDT
(In reply to Szymon Ptaszkiewicz from comment #14)
> I had a chat with Tom about that and we agreed that we should add only
> source folders for those projects that had already its source folder
> mentioned earlier which means only the entry for
> org.eclipse.equinox.app/osgi was missing.

I agree that the other source folders are probably not necessary today, but I think they should be added anyway. Just to be complete and to avoid surprises as soon as an Equinox API type refers to an OSGi type.

Furthermore, the Javadoc for org.eclipse.equinox.app.IApplicationContext#APPLICATION_ARGS contains {@link ApplicationDescriptor#launch(Map)}, but this link is not resolved in the generated doc: http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/equinox/app/IApplicationContext.html#APPLICATION_ARGS

I've added the missing reference to R5 compendium and added links to compendium/enterprise in the TOC: http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4a193a7354c18fcb37258ba43dd7672eac9a7a70