Hadoop Map/Reduce
  1. Hadoop Map/Reduce
  2. MAPREDUCE-2383

Improve documentation of DistributedCache methods

    Details

    • Hadoop Flags:
      Reviewed

      Description

      Users find the various methods in DistributedCache confusing - it's not clearly documented what the difference is between addArchiveToClassPath vs addFileToClassPath. We should improve the docs to clarify this and perhaps add an example that uses the DistributedCache.

        Activity

        Hide
        Nigel Daley added a comment -

        Would love to see this improved in 0.22 too!

        Show
        Nigel Daley added a comment - Would love to see this improved in 0.22 too!
        Hide
        Harsh J added a comment -

        Patch that updates Job's javadocs to reflect the difference.

        Show
        Harsh J added a comment - Patch that updates Job's javadocs to reflect the difference.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12478806/MAPREDUCE-2383.r1.diff
        against trunk revision 1101741.

        +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 (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://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//testReport/
        Findbugs warnings: https://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
        Console output: https://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//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/12478806/MAPREDUCE-2383.r1.diff against trunk revision 1101741. +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 (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://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//testReport/ Findbugs warnings: https://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://builds.apache.org/hudson/job/PreCommit-MAPREDUCE-Build/230//console This message is automatically generated.
        Hide
        Todd Lipcon added a comment -

        Committed to 0.22 and trunk. Thanks, Harsh!

        Show
        Todd Lipcon added a comment - Committed to 0.22 and trunk. Thanks, Harsh!
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Mapreduce-22-branch #48 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-22-branch/48/)
        MAPREDUCE-2383. Improve documentation of DistributedCache methods. Contributed by Harsh J Chouraria.

        Show
        Hudson added a comment - Integrated in Hadoop-Mapreduce-22-branch #48 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-22-branch/48/ ) MAPREDUCE-2383 . Improve documentation of DistributedCache methods. Contributed by Harsh J Chouraria.
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Mapreduce-trunk #679 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-trunk/679/)

        Show
        Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk #679 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-trunk/679/ )
        Hide
        Hudson added a comment -

        Integrated in Hadoop-Mapreduce-trunk-Commit #675 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-trunk-Commit/675/)

        Show
        Hudson added a comment - Integrated in Hadoop-Mapreduce-trunk-Commit #675 (See https://builds.apache.org/hudson/job/Hadoop-Mapreduce-trunk-Commit/675/ )

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development