Details

    • Type: Bug
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0.0-alpha
    • Fix Version/s: 3.0.0-alpha1
    • Component/s: documentation
    • Labels:
      None

      Description

      The javadocs don't include HDFS.

        Activity

        Hide
        tlipcon Todd Lipcon added a comment -

        This is intentional, since HDFS is only "private" APIs. At least that's the explanation we've claimed in the past.

        Show
        tlipcon Todd Lipcon added a comment - This is intentional, since HDFS is only "private" APIs. At least that's the explanation we've claimed in the past.
        Hide
        eli Eli Collins added a comment -

        Not sure that's true, there's a handful of @InterfaceAudience.Public annotations in hdfs.

        Show
        eli Eli Collins added a comment - Not sure that's true, there's a handful of @InterfaceAudience.Public annotations in hdfs.
        Hide
        tomwhite Tom White added a comment -

        Yes, that's what we've done in the past, see HADOOP-7732 and MAPREDUCE-559. There was a Ant javadoc-dev target for developers (as opposed to users) - which we didn't publish - perhaps we could do something similar in the Maven build.

        Show
        tomwhite Tom White added a comment - Yes, that's what we've done in the past, see HADOOP-7732 and MAPREDUCE-559 . There was a Ant javadoc-dev target for developers (as opposed to users) - which we didn't publish - perhaps we could do something similar in the Maven build.
        Hide
        eli Eli Collins added a comment -

        Now that we've got public APIs shouldn't we generate docs for them? Seems like we may have the reverse issue in common and MR, ie that we're publishing docs for classes that aren't public (ie InterfaceAudience#Private).

        Show
        eli Eli Collins added a comment - Now that we've got public APIs shouldn't we generate docs for them? Seems like we may have the reverse issue in common and MR, ie that we're publishing docs for classes that aren't public (ie InterfaceAudience#Private).
        Hide
        tomwhite Tom White added a comment -

        > Now that we've got public APIs shouldn't we generate docs for them?

        Yes, makes sense.

        > Seems like we may have the reverse issue in common and MR, ie that we're publishing docs for classes that aren't public (ie InterfaceAudience#Private).

        We use org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet to make sure we only publish public APIs. In the case of HDFS we should probably use IncludePublicAnnotationsStandardDoclet so that we only publish APIs that are explicitly marked @Public.

        Show
        tomwhite Tom White added a comment - > Now that we've got public APIs shouldn't we generate docs for them? Yes, makes sense. > Seems like we may have the reverse issue in common and MR, ie that we're publishing docs for classes that aren't public (ie InterfaceAudience#Private). We use org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet to make sure we only publish public APIs. In the case of HDFS we should probably use IncludePublicAnnotationsStandardDoclet so that we only publish APIs that are explicitly marked @Public.
        Hide
        jolly Jolly Chen added a comment -

        the pom.xml was already using org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet

        so just added a new group called 'HDFS' and removed org.apache.hadoop.hdfs* from the excludes

        non-public (i.e. packages that are not @InterfaceAudience.Public) packages are listed but are empty, as is the case now with similar packages from Common, MapReduce, and YARN.

        Show
        jolly Jolly Chen added a comment - the pom.xml was already using org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet so just added a new group called 'HDFS' and removed org.apache.hadoop.hdfs* from the excludes non-public (i.e. packages that are not @InterfaceAudience.Public) packages are listed but are empty, as is the case now with similar packages from Common, MapReduce, and YARN.
        Hide
        hadoopqa Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12603157/HDFS-3750.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in .

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/4972//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/4972//console

        This message is automatically generated.

        Show
        hadoopqa Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12603157/HDFS-3750.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in . +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/4972//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/4972//console This message is automatically generated.
        Hide
        aw Allen Wittenauer added a comment -

        +1

        Committed to trunk.

        Thanks!

        Show
        aw Allen Wittenauer added a comment - +1 Committed to trunk. Thanks!
        Hide
        hudson Hudson added a comment -

        SUCCESS: Integrated in Hadoop-trunk-Commit #6922 (See https://builds.apache.org/job/Hadoop-trunk-Commit/6922/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - SUCCESS: Integrated in Hadoop-trunk-Commit #6922 (See https://builds.apache.org/job/Hadoop-trunk-Commit/6922/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Yarn-trunk-Java8 #83 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/83/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Yarn-trunk-Java8 #83 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/83/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Yarn-trunk #817 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/817/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Yarn-trunk #817 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/817/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #80 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/80/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #80 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/80/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Hdfs-trunk #2015 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2015/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk #2015 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2015/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Mapreduce-trunk-Java8 #84 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/84/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • pom.xml
        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Mapreduce-trunk-Java8 #84 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/84/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) pom.xml hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        Hide
        hudson Hudson added a comment -

        FAILURE: Integrated in Hadoop-Mapreduce-trunk #2034 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2034/)
        HDFS-3750. API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de)

        • hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • pom.xml
        Show
        hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Mapreduce-trunk #2034 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2034/ ) HDFS-3750 . API docs don't include HDFS (Jolly Chen via aw) (aw: rev 6c3fec5ec25caabbd8c5ac795a5bc5229b5365de) hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt pom.xml

          People

          • Assignee:
            jolly Jolly Chen
            Reporter:
            eli Eli Collins
          • Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development