From d983ab621547adc1677573bc5fd5dbd0dcd74d83 Mon Sep 17 00:00:00 2001
From: Daniel Naber <dnaber@apache.org>
Date: Thu, 14 Oct 2004 20:23:03 +0000
Subject: [PATCH] improving documentation about compression, as suggested by
 Doug

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150610 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/fileformats.html | 11 +++++++++--
 xdocs/fileformats.xml | 11 +++++++++--
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/docs/fileformats.html b/docs/fileformats.html
index 051147f4fdc..b2efbf8a9e4 100644
--- a/docs/fileformats.html
+++ b/docs/fileformats.html
@@ -1328,11 +1328,18 @@ limitations under the License.
                         <ul>
                         	<li>low order bit is one for tokenized fields</li>
                         	<li>second bit is one for fields containing binary data</li>
-                        	<li>third bit is one for fields with compression option enabled</li>
+                        	<li>third bit is one for fields with compression option enabled
+                        		(if compression is enabled, the algorithm used is ZLIB)</li>
                         </ul>
                         </p>
                         <p>Value        --&gt;
-                            String (default) or byte[] when the field value is a binary field
+                            String | BinaryValue (depending on Bits)
+                        </p>
+                        <p>BinaryValue        --&gt;
+                            ValueSize, &lt;Byte&gt;^ValueSize
+                        </p>
+                        <p>ValueSize        --&gt;
+                            VInt
                         </p>
 
                     </li>
diff --git a/xdocs/fileformats.xml b/xdocs/fileformats.xml
index 84deabaa45b..2815ea17a95 100644
--- a/xdocs/fileformats.xml
+++ b/xdocs/fileformats.xml
@@ -912,11 +912,18 @@
                         <ul>
                         	<li>low order bit is one for tokenized fields</li>
                         	<li>second bit is one for fields containing binary data</li>
-                        	<li>third bit is one for fields with compression option enabled</li>
+                        	<li>third bit is one for fields with compression option enabled
+                        		(if compression is enabled, the algorithm used is ZLIB)</li>
                         </ul>
                         </p>
                         <p>Value        --&gt;
-                            String (default) or byte[] when the field value is a binary field
+                            String | BinaryValue (depending on Bits)
+                        </p>
+                        <p>BinaryValue        --&gt;
+                            ValueSize, &lt;Byte&gt;^ValueSize
+                        </p>
+                        <p>ValueSize        --&gt;
+                            VInt
                         </p>
 
                     </li>