From 12cc2005c163216c508074dccb239b3fb8bcdc58 Mon Sep 17 00:00:00 2001
From: stack <stack@apache.org>
Date: Wed, 7 Oct 2015 15:00:43 -0700
Subject: [PATCH] HBASE-14574 TableOutputFormat#getRecordWriter javadoc
 misleads

---
 .../hadoop/hbase/mapred/TableOutputFormat.java    | 15 +++++++++++++++
 .../hadoop/hbase/mapreduce/TableOutputFormat.java |  5 +++++
 2 files changed, 20 insertions(+)

diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java
index 6e0d9e70e08..dd72939e8f9 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapred/TableOutputFormat.java
@@ -71,6 +71,21 @@ public class TableOutputFormat extends FileOutputFormat<ImmutableBytesWritable,
     }
   }
 
+  /**
+   * Creates a new record writer.
+   * 
+   * Be aware that the baseline javadoc gives the impression that there is a single
+   * {@link RecordWriter} per job but in HBase, it is more natural if we give you a new
+   * RecordWriter per call of this method. You must close the returned RecordWriter when done.
+   * Failure to do so will drop writes.
+   *
+   * @param ignored Ignored filesystem
+   * @param job Current JobConf
+   * @param name Name of the job
+   * @param progress
+   * @return The newly created writer instance.
+   * @throws IOException When creating the writer fails.
+   */
   @Override
   public RecordWriter getRecordWriter(FileSystem ignored, JobConf job, String name,
       Progressable progress)
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java
index 6e4b470ddf9..7a137508c20 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/mapreduce/TableOutputFormat.java
@@ -131,6 +131,11 @@ implements Configurable {
 
   /**
    * Creates a new record writer.
+   * 
+   * Be aware that the baseline javadoc gives the impression that there is a single
+   * {@link RecordWriter} per job but in HBase, it is more natural if we give you a new
+   * RecordWriter per call of this method. You must close the returned RecordWriter when done.
+   * Failure to do so will drop writes.
    *
    * @param context  The current task context.
    * @return The newly created writer instance.