MAPREDUCE-2383. Improve documentation of DistributedCache methods. Contributed by Harsh J Chouraria.
git-svn-id: https://svn.apache.org/repos/asf/hadoop/mapreduce/trunk@1102187 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/CHANGES.txt b/CHANGES.txt
index 3c5b987..747c5ff 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -373,6 +373,9 @@
MAPREDUCE-2337. Remove dependence of public MapReduce API on classes in
server package. (tomwhite)
+ MAPREDUCE-2383. Improve documentation of DistributedCache methods (Harsh J
+ Chouraria via todd)
+
OPTIMIZATIONS
MAPREDUCE-1354. Enhancements to JobTracker for better performance and
diff --git a/src/java/org/apache/hadoop/mapreduce/Job.java b/src/java/org/apache/hadoop/mapreduce/Job.java
index 251437e..e802037 100644
--- a/src/java/org/apache/hadoop/mapreduce/Job.java
+++ b/src/java/org/apache/hadoop/mapreduce/Job.java
@@ -856,6 +856,11 @@
* 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 @@
* 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)
