Hadoop Common
  1. Hadoop Common
  2. HADOOP-6504

Invalid example in the documentation of org.apache.hadoop.util.Tool

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.20.1
    • Fix Version/s: 0.21.0
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      The example with the class MyApp doesn't work.
      The run method needs to return an int (return 0; needs to be added at the end of the method) and main does a new Sort() instead of new MyApp()

      1. HADOOP-6504.patch
        1 kB
        Benoit Sigoure

        Activity

        Hide
        Benoit Sigoure added a comment -

        Patch that fixes the issue.

        Show
        Benoit Sigoure added a comment - Patch that fixes the issue.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12431285/HADOOP-6504.patch
        against trunk revision 916779.

        +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 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 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.

        Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/testReport/
        Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/artifact/trunk/build/test/checkstyle-errors.html
        Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/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/12431285/HADOOP-6504.patch against trunk revision 916779. +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 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 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. Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/testReport/ Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/artifact/trunk/build/test/checkstyle-errors.html Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/392/console This message is automatically generated.
        Hide
        Tom White added a comment -

        I've just committed this. Thanks Benoit!

        Show
        Tom White added a comment - I've just committed this. Thanks Benoit!
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk-Commit #196 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Common-trunk-Commit/196/)
        . Invalid example in the documentation of org.apache.hadoop.util.Tool. Contributed by Benoit Sigoure.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk-Commit #196 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Common-trunk-Commit/196/ ) . Invalid example in the documentation of org.apache.hadoop.util.Tool. Contributed by Benoit Sigoure.
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Common-trunk #273 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Common-trunk/273/)
        . Invalid example in the documentation of org.apache.hadoop.util.Tool. Contributed by Benoit Sigoure.

        Show
        Hudson added a comment - Integrated in Hadoop-Common-trunk #273 (See http://hudson.zones.apache.org/hudson/job/Hadoop-Common-trunk/273/ ) . Invalid example in the documentation of org.apache.hadoop.util.Tool. Contributed by Benoit Sigoure.

          People

          • Assignee:
            Benoit Sigoure
            Reporter:
            Benoit Sigoure
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 0.25h
              0.25h
              Remaining:
              Remaining Estimate - 0.25h
              0.25h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development