summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2019-01-02 23:02:22 (GMT)
committerYann Collet <cyan@fb.com>2019-01-02 23:02:22 (GMT)
commitec735ac53e6b216efcbcd411d496dc90b058c570 (patch)
treea286658f381fb1c1f2d1e08e39daef3157aa1cae
parent7a4e04e6a683cab6dd8961c898a7164d3b2ecc7c (diff)
downloadlz4-ec735ac53e6b216efcbcd411d496dc90b058c570.zip
lz4-ec735ac53e6b216efcbcd411d496dc90b058c570.tar.gz
lz4-ec735ac53e6b216efcbcd411d496dc90b058c570.tar.bz2
updated frame format
re-wording non-full blocks, for clarity.
-rw-r--r--doc/lz4_Frame_format.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/lz4_Frame_format.md b/doc/lz4_Frame_format.md
index a8541f5..a0514e0 100644
--- a/doc/lz4_Frame_format.md
+++ b/doc/lz4_Frame_format.md
@@ -265,20 +265,23 @@ The highest bit is “1” if data in the block is uncompressed.
The highest bit is “0” if data in the block is compressed by LZ4.
-All other bits give the size, in bytes, of the following data block
-(the size does not include the block checksum if present).
+All other bits give the size, in bytes, of the following data block.
+The size does not include the block checksum if present.
Block Size shall never be larger than Block Maximum Size.
-Such a thing could happen for incompressible source data.
-In such case, such a data block shall be passed in uncompressed format.
+Such a thing could potentially happen for non-compressible sources.
+In such a case, such data block shall be passed using uncompressed format.
__Data__
Where the actual data to decode stands.
It might be compressed or not, depending on previous field indications.
-Uncompressed size of Data can be any size, up to “block maximum size”.
-Note that data block is not necessarily full :
-an arbitrary “flush” may happen anytime. Any block can be “partially filled”.
+
+When compressed, the data must respect the [LZ4 block format specification](https://github.com/lz4/lz4/blob/master/doc/lz4_Block_format.md).
+
+Note that the block is not necessarily full.
+Uncompressed size of data can be any size, up to "Block Maximum Size”,
+so it may contain less data than the maximum block size.
__Block checksum__