Fix mvn javadoc:jar failure due to HadoopFsWrapper. #3729
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes a failure I ran into while doing the 0.9.2 release:
I believe the issue is that HadoopFsWrapper accepts "FileSystem" as a parameter in a public method, so javadoc tries to generate javadocs for it, but then it bombs out when it tries to figure out what a FileSystem is. The error refers to a
InterfaceAudience$Public
class, which is an annotation. We probably could fix this by including hadoop-annotations jar. But, I don't want to do a patch that includes new jars so close to a release, so instead I suggest this patch which just disables javadoc generation for that class. This is against the 0.9.2 branch so we could potentially do a different approach in master.This was not caught in the RC phase because we run "mvn javadoc:aggregate" there rather than "mvn javadoc:jar", and the aggregate command worked fine.
I tested "mvn javadoc:jar" and it works after this patch.