svn commit: r1102188 - in /hadoop/mapreduce/branches/branch-0.22: CHANGES.txt src/java/org/apache/hadoop/mapreduce/Job.java

[to...@apache.org]

Author: todd
Date: Thu May 12 07:21:45 2011
New Revision: 1102188

URL: http://svn.apache.org/viewvc?rev=1102188&view=rev
Log:
MAPREDUCE-2383. Improve documentation of DistributedCache methods. Contributed by Harsh J Chouraria.

Modified:
    hadoop/mapreduce/branches/branch-0.22/CHANGES.txt
    hadoop/mapreduce/branches/branch-0.22/src/java/org/apache/hadoop/mapreduce/Job.java

Modified: hadoop/mapreduce/branches/branch-0.22/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/mapreduce/branches/branch-0.22/CHANGES.txt?rev=1102188&r1=1102187&r2=1102188&view=diff
==============================================================================
--- hadoop/mapreduce/branches/branch-0.22/CHANGES.txt (original)
+++ hadoop/mapreduce/branches/branch-0.22/CHANGES.txt Thu May 12 07:21:45 2011
@@ -197,6 +197,9 @@ Release 0.22.0 - Unreleased
     MAPREDUCE-2410. Add entry to streaming FAQ about how streaming reducers
     receive keys. (Harsh J Chouraria via todd)
 
+    MAPREDUCE-2383. Improve documentation of DistributedCache methods (Harsh J
+    Chouraria via todd)
+
   OPTIMIZATIONS
     
     MAPREDUCE-1354. Enhancements to JobTracker for better performance and

Modified: hadoop/mapreduce/branches/branch-0.22/src/java/org/apache/hadoop/mapreduce/Job.java
URL: http://svn.apache.org/viewvc/hadoop/mapreduce/branches/branch-0.22/src/java/org/apache/hadoop/mapreduce/Job.java?rev=1102188&r1=1102187&r2=1102188&view=diff
==============================================================================
--- hadoop/mapreduce/branches/branch-0.22/src/java/org/apache/hadoop/mapreduce/Job.java (original)
+++ hadoop/mapreduce/branches/branch-0.22/src/java/org/apache/hadoop/mapreduce/Job.java Thu May 12 07:21:45 2011
@@ -856,6 +856,11 @@ public class Job extends JobContextImpl 
    * Add an file path to the current set of classpath entries It adds the file
    * to cache as well.
    * 
+   * Files added with this method will not be unpacked while being added to the
+   * classpath.
+   * To add archives to classpath, use the {@link #addArchiveToClassPath(Path)}
+   * method instead.
+   *
    * @param file Path of the file to be added
    */
   public void addFileToClassPath(Path file)
@@ -868,6 +873,9 @@ public class Job extends JobContextImpl 
    * Add an archive path to the current set of classpath entries. It adds the
    * archive to cache as well.
    * 
+   * Archive files will be unpacked and added to the classpath
+   * when being distributed.
+   *
    * @param archive Path of the archive to be added
    */
   public void addArchiveToClassPath(Path archive)