[HBASE-19663] javadoc creation needs jsr305

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha-1, 1.6.0, 1.4.11, 2.4.0
• Component/s: documentation, website
• Assignee: Sean Busbey
• Reporter: Michael Stack
• Created: 29/Dec/17 09:19
• Updated: 25/Nov/24 09:37
• Resolved: 18/Oct/19 05:09

Description

Cryptic failure trying to build beta-1 RC. Fails like this:

[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 03:54 min
[INFO] Finished at: 2017-12-29T01:13:15-08:00
[INFO] Final Memory: 381M/9165M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.4:site (default-site) on project hbase: Error generating maven-javadoc-plugin:2.10.3:aggregate:
[ERROR] Exit code: 1 - warning: unknown enum constant When.ALWAYS
[ERROR] reason: class file for javax.annotation.meta.When not found
[ERROR] warning: unknown enum constant When.UNKNOWN
[ERROR] warning: unknown enum constant When.MAYBE
[ERROR] /home/stack/hbase.git/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java:762: warning - Tag @link: malformed: "#matchingRows(Cell, byte[]))"
[ERROR] /home/stack/hbase.git/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java:762: warning - Tag @link: reference not found: #matchingRows(Cell, byte[]))
[ERROR] /home/stack/hbase.git/hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java:762: warning - Tag @link: reference not found: #matchingRows(Cell, byte[]))
[ERROR] javadoc: warning - Class javax.annotation.Nonnull not found.
[ERROR] javadoc: error - class file for javax.annotation.meta.TypeQualifierNickname not found
[ERROR]
[ERROR] Command line was: /home/stack/bin/jdk1.8.0_151/jre/../bin/javadoc -J-Xmx2G @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/home/stack/hbase.git/target/site/apidocs' dir.
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

javax.annotation.meta.TypeQualifierNickname is out of jsr305 but we don't include this anywhere according to mvn dependency.

Happens building the User API both test and main.

Excluding these lines gets us passing again:

  3511               <doclet>
  3512                 org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet
  3513               </doclet>
  3514               <docletArtifact>
  3515                 <groupId>org.apache.yetus</groupId>
  3516                 <artifactId>audience-annotations</artifactId>
  3517                 <version>${audience-annotations.version}</version>
  3518               </docletArtifact>
+ 3519               <useStandardDocletOptions>true</useStandardDocletOptions>

Tried upgrading to newer mvn site (ours is three years old) but that a different set of problems.

Issue Links

• blocks: HBASE-22033 Update to maven-javadoc-plugin 3.2.0 and switch to non-forking aggregate goals
• blocks: HBASE-22991 Release 1.4.11
• is related to: HBASE-19196 Release hbase-2.0.0-beta-1; the "Finish-line" release
• is related to: HBASE-19780 Change execution phase of checkstyle plugin back to default 'verify'
• relates to: BIGTOP-3297 Bump HBase to 1.5.0
• relates to: HBASE-21861 Handle the missing file issues from the Linkchecker job

Sub-Tasks

• Workaround: Purge User API building from branch-2 so can make a beta-1: Closed
• Revert Workaround: Purge User API building from branch-2 so can make a beta-1: Closed