Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-8297

Writable javadocs don't carry default constructor

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 2.0.0-alpha
    • Fix Version/s: 3.0.0-alpha1
    • Component/s: documentation
    • Labels:
      None
    • Tags:
      trivial

      Description

      The Writable API docs have a custom writable example but doesn't carry a default constructor in it. Apparently a default constructor is required and hence the example ought to carry it for benefit of the reader/paster.

        Activity

        Hide
        qwertymaniac Harsh J added a comment -

        Patch that adds this in, along with some extra whitespace removal from that chunk of the javadoc.

        Show
        qwertymaniac Harsh J added a comment - Patch that adds this in, along with some extra whitespace removal from that chunk of the javadoc.
        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/12523479/HADOOP-8297.patch
        against trunk revision .

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

        -1 tests included. The patch doesn't appear to include any new or modified tests.
        Please justify why no new tests are needed for this patch.
        Also please list what manual steps were performed to verify this patch.

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

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

        +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-HADOOP-Build/873//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/873//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/12523479/HADOOP-8297.patch against trunk revision . +1 @author. The patch does not contain any @author tags. -1 tests included. The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +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-HADOOP-Build/873//testReport/ Console output: https://builds.apache.org/job/PreCommit-HADOOP-Build/873//console This message is automatically generated.
        Hide
        qwertymaniac Harsh J added a comment -

        Given that this is a trivial patch that just fixes javadocs for developers, if no one has further comments on the helpful changes introduced here I will commit this in by monday.

        Show
        qwertymaniac Harsh J added a comment - Given that this is a trivial patch that just fixes javadocs for developers, if no one has further comments on the helpful changes introduced here I will commit this in by monday.
        Hide
        qwertymaniac Harsh J added a comment -

        Committed the doc addition to trunk.

        Show
        qwertymaniac Harsh J added a comment - Committed the doc addition to trunk.
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Hdfs-trunk-Commit #2319 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/2319/)
        HADOOP-8297. Writable javadocs don't carry default constructor (harsh) (Revision 1338557)

        Result = SUCCESS
        harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557
        Files :

        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Hdfs-trunk-Commit #2319 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/2319/ ) HADOOP-8297 . Writable javadocs don't carry default constructor (harsh) (Revision 1338557) Result = SUCCESS harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Common-trunk-Commit #2245 (See https://builds.apache.org/job/Hadoop-Common-trunk-Commit/2245/)
        HADOOP-8297. Writable javadocs don't carry default constructor (harsh) (Revision 1338557)

        Result = SUCCESS
        harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557
        Files :

        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Common-trunk-Commit #2245 (See https://builds.apache.org/job/Hadoop-Common-trunk-Commit/2245/ ) HADOOP-8297 . Writable javadocs don't carry default constructor (harsh) (Revision 1338557) Result = SUCCESS harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Hide
        hudson Hudson added a comment -

        Integrated in Hadoop-Mapreduce-trunk-Commit #2261 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Commit/2261/)
        HADOOP-8297. Writable javadocs don't carry default constructor (harsh) (Revision 1338557)

        Result = ABORTED
        harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557
        Files :

        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt
        • /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Show
        hudson Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk-Commit #2261 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Commit/2261/ ) HADOOP-8297 . Writable javadocs don't carry default constructor (harsh) (Revision 1338557) Result = ABORTED harsh : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1338557 Files : /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/io/Writable.java
        Hide
        sureshms Suresh Srinivas added a comment -

        Harsh, given that this is a trivial change, can you please merge this to branch-2 and branch-2.1.0-beta. That way the delta between trunk and 2.1.0-beta is small.

        Show
        sureshms Suresh Srinivas added a comment - Harsh, given that this is a trivial change, can you please merge this to branch-2 and branch-2.1.0-beta. That way the delta between trunk and 2.1.0-beta is small.
        Hide
        sureshms Suresh Srinivas added a comment -

        BTW please make sure the trunk CHANGES.txt is updated to move this jira to the appropriate release section, if you end up merging this change.

        Show
        sureshms Suresh Srinivas added a comment - BTW please make sure the trunk CHANGES.txt is updated to move this jira to the appropriate release section, if you end up merging this change.

          People

          • Assignee:
            qwertymaniac Harsh J
            Reporter:
            qwertymaniac Harsh J
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development