Javadoc build failures

[akurtakov]

Recently we see javadoc build failures (https://download.eclipse.org/eclipse/downloads/drops4/I20220505-0320/compilelogs/platform.doc.isv.javadoc.txt) :

../../../rt.equinox.bundles/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:17: error: package org.osgi.service.prefs does not exist
import org.osgi.service.prefs.BackingStoreException;
                             ^
../../../rt.equinox.bundles/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:18: error: package org.osgi.service.prefs does not exist
import org.osgi.service.prefs.Preferences;
                             ^
../../../eclipse.platform/ant/org.eclipse.ant.core/src/org/eclipse/ant/core/AntCorePreferences.java:70: error: package org.osgi.service.prefs does not exist
import org.osgi.service.prefs.BackingStoreException;
                             ^
../../../rt.equinox.bundles/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:31: error: cannot find symbol
public interface IEclipsePreferences extends Preferences {
                                             ^
  symbol: class Preferences
../../../rt.equinox.bundles/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IEclipsePreferences.java:162: error: cannot find symbol
		public Preferences getNode() {
		       ^
....

and similar in https://download.eclipse.org/eclipse/downloads/drops4/I20220505-0320/compilelogs/jdt.doc.isv.javadoc.txt and https://download.eclipse.org/eclipse/downloads/drops4/I20220505-0320/compilelogs/pde.doc.user.javadoc.txt.
@HannesWell I think these are related to org.osgi.service.prefs not ending up on javadoc tool paths.

[akurtakov]

@sravanlakkimsetti Maybe you can help with this one?

[HannesWell]

and similar in https://download.eclipse.org/eclipse/downloads/drops4/I20220505-0320/compilelogs/jdt.doc.isv.javadoc.txt and https://download.eclipse.org/eclipse/downloads/drops4/I20220505-0320/compilelogs/pde.doc.user.javadoc.txt. @HannesWell I think these are related to org.osgi.service.prefs not ending up on javadoc tool paths.

Yes this looks really related to my latest change.
But I have no clue how the java-doc build works or where I could add some dependencies. If you give me a pointer, I can try to add the missing dependencies.

[mickaelistria]

See the pom.xml files in this repo, they do list the "extra dependencies" to add to Javadoc. However what I don't get is why this becomes suddenly necessary. Is it because the bundle was missing in some feature or something of that sort?

[sravanlakkimsetti]

Javadoc generation uses a independent javadoc executable and runs as a separate process. We will need to add all the required dependencies in the classpath used by javadoc executable. This done in the <project>Options.txt files inside documentation bundles projects.

PR is getting created now

[laeubi]

Javadoc generation uses a independent javadoc executable and runs as a separate process.

Is there any reason not using tycho + automatic resolution of dependencies here?

[sravanlakkimsetti]

Javadoc generation uses a independent javadoc executable and runs as a separate process.

Is there any reason not using tycho + automatic resolution of dependencies here?

I am not sure of this. But this is like this from quite long time. It may be good idea to change to tycho + automatic resolution

[HannesWell]

Thank you Sravan for fixing this.

Without knowing anything about this java-doc build (maybe it is doing something special) I want to mention that maybe the standard Maven-Javadoc-Plugin could be used with Tycho to build the javadoc.

[sravanlakkimsetti]

We use ant to build javadoc bundles. One of the ant script is here https://github.com/eclipse-platform/eclipse.platform.common/blob/master/bundles/org.eclipse.jdt.doc.isv/buildDoc.xml. Can we convert this to maven?