Hadoop Common
  1. Hadoop Common
  2. HADOOP-7078

Add better javadocs for RawComparator interface

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.23.0
    • Fix Version/s: 0.23.0
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      The RawComparator interface is very important to understand for users implementing their own serialization classes. Right now the javadoc is woefully sparse. We should improve that.

        Activity

        Todd Lipcon created issue -
        Hide
        Harsh J added a comment -

        Attaching a javadoc patch that hopefully adds more details to RawComparator. Please review (correct me if am wrong anywhere too!).

        Show
        Harsh J added a comment - Attaching a javadoc patch that hopefully adds more details to RawComparator. Please review (correct me if am wrong anywhere too!).
        Harsh J made changes -
        Field Original Value New Value
        Attachment common.rawcomparator.jdoc.r1.diff [ 12466968 ]
        Harsh J made changes -
        Assignee Harsh J Chouraria [ qwertymaniac ]
        Todd Lipcon made changes -
        Project Hadoop Map/Reduce [ 12310941 ] Hadoop Common [ 12310240 ]
        Key MAPREDUCE-1591 HADOOP-7078
        Affects Version/s 0.23.0 [ 12315569 ]
        Affects Version/s 0.22.0 [ 12314184 ]
        Assignee Harsh J Chouraria [ qwertymaniac ]
        Hide
        Todd Lipcon added a comment -

        Fixed typo of comparision -> comparison. +1

        Show
        Todd Lipcon added a comment - Fixed typo of comparision -> comparison. +1
        Todd Lipcon made changes -
        Attachment hadoop-7078-fixed-typos.txt [ 12466975 ]
        Todd Lipcon made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Hide
        Todd Lipcon added a comment -

        Can someone please add Harsh to the contributors list for the HADOOP jira so we can assign this to him?

        Show
        Todd Lipcon added a comment - Can someone please add Harsh to the contributors list for the HADOOP jira so we can assign this to him?
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12466975/hadoop-7078-fixed-typos.txt
        against trunk revision 1052420.

        +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 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 core unit tests.

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

        +1 system test framework. The patch passed system test framework compile.

        Test results: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//testReport/
        Findbugs warnings: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Console output: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12466975/hadoop-7078-fixed-typos.txt against trunk revision 1052420. +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 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 core unit tests. +1 contrib tests. The patch passed contrib unit tests. +1 system test framework. The patch passed system test framework compile. Test results: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//testReport/ Findbugs warnings: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://hudson.apache.org/hudson/job/PreCommit-HADOOP-Build/150//console This message is automatically generated.
        Todd Lipcon made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Hadoop Flags [Reviewed]
        Fix Version/s 0.23.0 [ 12315569 ]
        Resolution Fixed [ 1 ]
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk-Commit #462 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk-Commit/462/)
        HADOOP-7078. Improve javadocs for RawComparator interface. Contributed by Harsh J Chouraria.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk-Commit #462 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk-Commit/462/ ) HADOOP-7078 . Improve javadocs for RawComparator interface. Contributed by Harsh J Chouraria.
        Jakob Homan made changes -
        Assignee Harsh J Chouraria [ qwertymaniac ]
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk #558 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk/558/)
        HADOOP-7078. Improve javadocs for RawComparator interface. Contributed by Harsh J Chouraria.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk #558 (See https://hudson.apache.org/hudson/job/Hadoop-Common-trunk/558/ ) HADOOP-7078 . Improve javadocs for RawComparator interface. Contributed by Harsh J Chouraria.
        Arun C Murthy made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Harsh J
            Reporter:
            Todd Lipcon
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development