-
Notifications
You must be signed in to change notification settings - Fork 28.4k
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
[SPARK-14511][Build] Upgrade genjavadoc to latest upstream #12707
Conversation
cc @mengxr |
Test build #57016 has finished for PR 12707 at commit
|
Seems reasonable to me if the upstream version does all that's needed. |
The work I submitted upstream doesn't specifically target that issue, On Wed, Apr 27, 2016 at 1:14 AM, Sean Owen [email protected] wrote:
|
I saw some errors running this locally though
Any idea what's going on here? |
Actually, it looks like this might be broken even prior to this patch :( |
Hmm, the current genjavadoc also produces errors on Spark so I didn't really look into it (I tested the upstream fix on Akka). How does the final output compare? Could this be due to java 8's stricter behaviour as @srowen mentioned? |
@JoshRosen Are you using Java 8? I tested this on Java 7 with the latest master. It worked fine. |
Yeah, I think that was it. Forgot that I had pinned Java 7 for docs on Jenkins. |
Though the doc compiles, it doesn't seem that the package private objects are hidden. Attached a snapshot. @jodersky Could you double check? |
Yeah, the problem is that Java 8 has a much stricter javadoc tool. @jodersky you seem pretty plugged in to genjavadoc or am I imagining that? I think I had a PR open or at least a suggestion for fixing one of those. |
@srowen, I did quite some digging through the genjavadoc codebase when re-implementing @mengxr's initial fix. I can try to fix the group warnings and object privacy issues, however I can't give you a fixed deadline since I won't be available until the 10th. |
+1 on merging this first and fixing remaining issues later. |
Merged to master |
I created https://issues.apache.org/jira/browse/SPARK-15006 and lightbend/genjavadoc#83 to track the issue with package private objects. |
What changes were proposed in this pull request?
In the past, genjavadoc had issues with package private members which led the spark project to use a forked version. This issue has been fixed upstream (lightbend/genjavadoc#70) and a release is available for scala versions 2.10, 2.11 and 2.12, hence a forked version for spark is no longer necessary.
This pull request updates the build configuration to use the newest upstream genjavadoc.
How was this patch tested?
The build was run
sbt unidoc
. During the process javadoc emits some errors on the generated java stubs, however these errors were also present before the upgrade. Furthermore, the produced html is fine.