From 9d7d022ec639d048a68dafcc721f2ea205a0fd9f Mon Sep 17 00:00:00 2001
From: Doug Meil <dmeil@apache.org>
Date: Fri, 10 Feb 2012 18:27:42 +0000
Subject: [PATCH] hbase-5380.  book.xml, comment about KeyValue instances not
 being split across blocks

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1242878 13f79535-47bb-0310-9956-ffa450edef68
---
 src/docbkx/book.xml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/docbkx/book.xml b/src/docbkx/book.xml
index d04582b0750..d1fa1cfff76 100644
--- a/src/docbkx/book.xml
+++ b/src/docbkx/book.xml
@@ -2082,7 +2082,7 @@ myHtd.setValue(HTableDescriptor.SPLIT_POLICY, MyCustomSplitPolicy.class.getName(
       <section xml:id="keyvalue">
         <title>KeyValue</title>
         <para>The KeyValue class is the heart of data storage in HBase.  KeyValue wraps a byte array and takes offsets and lengths into passed array
-         at where to start interpreting the content as KeyValue.
+         at where to start interpreting the content as KeyValue.  
         </para>
         <para>The KeyValue format inside a byte array is:
            <itemizedlist>
@@ -2103,7 +2103,9 @@ myHtd.setValue(HTableDescriptor.SPLIT_POLICY, MyCustomSplitPolicy.class.getName(
              <listitem>keytype (e.g., Put, Delete, DeleteColumn, DeleteFamily)</listitem>
            </itemizedlist>
         </para>
-        <para>For more information, see the <link xlink:href="http://hbase.apache.org/xref/org/apache/hadoop/hbase/KeyValue.html">KeyValue source code</link>.
+        <para>KeyValue instances are <emphasis>not</emphasis> split across blocks.
+         For example, if there is an 8 MB KeyValue, even if the block-size is 64kb this KeyValue will be read
+         in as a coherent block.  For more information, see the <link xlink:href="http://hbase.apache.org/xref/org/apache/hadoop/hbase/KeyValue.html">KeyValue source code</link>.
         </para>
         <section xml:id="keyvalue.example"><title>Example</title>
           <para>To emphasize the points above, examine what happens with two Puts for two different columns for the same row:</para>