-
Notifications
You must be signed in to change notification settings - Fork 29.1k
[SPARK-12000] Fix API doc generation issues #10049
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Chatted with @thunterdb and we figured out that the Scala compiler error reported in SPARK-12000 does not occur under Java 8. Tim's Javadoc changes in his PR are required for Javadoc compilation to work under JDK 8, but do not address the issue where Scaladoc compilation fails under Java 7. I'm going to see if I can fix the Java 7 doc build, since we use Java 7 for release and snapshot builds. In principle, we could use Java 8 to do the snapshot builds while targeting Java 7, but then we'd have to configure out build to use a Java 7 class library in oder to avoid the introduction of subtle incompatibilities caused by Java 8 standard library classes being used. |
|
It looks like Jenkins is able to successfully generate the Scaladocs using Java 7, but my Mac laptop hits that compiler error. I'm going to try upgrading to a newer Java 7 JDK to see if that resolves things. For posterity, I'm currently encountering the compiler issues while using the following JDK: |
|
Yep, looks like upgrading to a newer JDK fixed things. Here's what worked for me: Given that using a newer JDK seems to be how we've been able to successfully publish Scaladoc for 1.5.x, I'm going to go ahead and recommend a JDK upgrade as the solution to the Scaladoc issue. Therefore, I think that we're good to merge this and resolve the JIRA issue. |
|
LGTM |
|
Going to merge this now into master and branch-1.6. |
This pull request fixes multiple issues with API doc generation. - Modify the Jekyll plugin so that the entire doc build fails if API docs cannot be generated. This will make it easy to detect when the doc build breaks, since this will now trigger Jenkins failures. - Change how we handle the `-target` compiler option flag in order to fix `javadoc` generation. - Incorporate doc changes from thunterdb (in #10048). Closes #10048. Author: Josh Rosen <[email protected]> Author: Timothy Hunter <[email protected]> Closes #10049 from JoshRosen/fix-doc-build. (cherry picked from commit d3ca8cf) Signed-off-by: Josh Rosen <[email protected]>
|
Test build #46907 has finished for PR 10049 at commit
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops, forgot the quotes here. Will fix in a followup PR or a hotfix.
|
Hmm, now I seem to have started having problems even in spite of the JDK update. Will investigate. |
|
Now I'm very confused: it looks like Jenkins is actually using a different Java 7 JDK: |
I accidentally omitted these as part of #10049.
I accidentally omitted these as part of #10049.
This pull request fixes multiple issues with API doc generation.
-targetcompiler option flag in order to fixjavadocgeneration.Closes #10048.