Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.95.0
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      https://builds.apache.org/job/PreCommit-HBASE-Build/4470//artifact/trunk/patchprocess/patchJavadocWarnings.txt :

      [WARNING] Javadoc Warnings
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/snapshot/RegionServerSnapshotManager.java:73: warning - Tag @link: can't find stop() in org.apache.hadoop.hbase.regionserver.snapshot.RegionServerSnapshotManager
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java:1021: warning - @param argument "table" is not a parameter name.
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/SnapshotDescriptionUtils.java:73: warning - Tag @link: can't find completeSnapshot(SnapshotDescription, Path, Path, FileSystem) in org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/snapshot/TakeSnapshotUtils.java:84: warning - Tag @link: can't find getRegionSnapshotDirectory(SnapshotDescription, Path, String) in org.apache.hadoop.hbase.snapshot.TakeSnapshotUtils
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java:1758: warning - Tag @see: can't find logZKTree(String) in org.apache.hadoop.hbase.zookeeper.ZKUtil
      [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/master/snapshot/SnapshotFileCache.java:73: warning - Tag @link: reference not found: SnapshotFileInspector
      
      1. hbase-7889.v3.patch
        5 kB
        Jonathan Hsieh
      2. 7889-v2.txt
        5 kB
        Ted Yu
      3. 7889-v1.txt
        3 kB
        Ted Yu

        Activity

        Hide
        stack added a comment -

        Marking closed.

        Show
        stack added a comment - Marking closed.
        Hide
        Jonathan Hsieh added a comment -

        I've committed a minor addendum to make the commit match v3. (which is legit according to http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide)

        Show
        Jonathan Hsieh added a comment - I've committed a minor addendum to make the commit match v3. (which is legit according to http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide )
        Hide
        Jonathan Hsieh added a comment - - edited

        ran this on patch v3:

        # essentially equivalent to dev-support/test-patch.sh 's javadoc testing stuff.
        mvn clean package javadoc:javadoc -DskipTests -DHBasePatchProcess > patchjavadocwarn.txt 2>&1 
        cat  patchjavadocwarn.txt  | grep '\[WARN' | grep -v "Javadoc Warnings" | grep warning  | wc -l
        

        and got 2, which is the acceptable # of javadoc warning.

        Show
        Jonathan Hsieh added a comment - - edited ran this on patch v3: # essentially equivalent to dev-support/test-patch.sh 's javadoc testing stuff. mvn clean package javadoc:javadoc -DskipTests -DHBasePatchProcess > patchjavadocwarn.txt 2>&1 cat patchjavadocwarn.txt | grep '\[WARN' | grep -v "Javadoc Warnings" | grep warning | wc -l and got 2, which is the acceptable # of javadoc warning.
        Hide
        Jonathan Hsieh added a comment -

        v3 seems to fix the problem.

        Show
        Jonathan Hsieh added a comment - v3 seems to fix the problem.
        Hide
        Ted Yu added a comment -

        I got the idea from HBASE-7363:

        -   * Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLED}.
        +   * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLED}.
        

        The usage of @code is already in trunk.

        Show
        Ted Yu added a comment - I got the idea from HBASE-7363 : - * Go to zookeeper and see if state of table is {@link ZooKeeperProtos.Table.State#DISABLED}. + * Go to zookeeper and see if state of table is {@code ZooKeeperProtos.Table.State#DISABLED}. The usage of @code is already in trunk.
        Hide
        Jonathan Hsieh added a comment -

        @code will make the warning go away, but just does text formatting. there has to be something else we can use.

        Show
        Jonathan Hsieh added a comment - @code will make the warning go away, but just does text formatting. there has to be something else we can use.
        Hide
        Jesse Yates added a comment -

        +1 looks good to me. Let's let QA run it through after snapshots gets merged.

        Show
        Jesse Yates added a comment - +1 looks good to me. Let's let QA run it through after snapshots gets merged.
        Hide
        Ted Yu added a comment -

        Patch v2 fixes all the listed javadoc warnings

        Show
        Ted Yu added a comment - Patch v2 fixes all the listed javadoc warnings
        Hide
        Jonathan Hsieh added a comment -

        Let's get the java doc stuff fixed, commit it to the branch and then I'll merge.

        Show
        Jonathan Hsieh added a comment - Let's get the java doc stuff fixed, commit it to the branch and then I'll merge.
        Hide
        Matteo Bertozzi added a comment -

        looks good. maybe the link is

        {@link SnapshotFileCache.SnapshotFileInspector}

        since the class is inside another? (not sure about that)

        Show
        Matteo Bertozzi added a comment - looks good. maybe the link is {@link SnapshotFileCache.SnapshotFileInspector} since the class is inside another? (not sure about that)
        Hide
        Ted Yu added a comment -

        Patch v1 addresses 4 out of 6 warnings.

        Show
        Ted Yu added a comment - Patch v1 addresses 4 out of 6 warnings.

          People

          • Assignee:
            Ted Yu
            Reporter:
            Ted Yu
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development