From 61d74164254d49508df7fb2c213b5346d00f8ac2 Mon Sep 17 00:00:00 2001 From: Yann Collet Date: Mon, 6 Apr 2015 01:03:49 +0100 Subject: updated doc --- README.md | 11 +++++------ lz4_Frame_format.md | 4 ++-- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6de310a..bcb8d7c 100644 --- a/README.md +++ b/README.md @@ -50,13 +50,12 @@ in single-thread mode. |**LZ4 HC (r129)** |**2.720**| 22 MB/s | **1830 MB/s** | | zlib 1.2.8 -6 | 3.099 | 18 MB/s | 270 MB/s | -The LZ4 block compression format is detailed within [lz4_Block_format]. +The raw LZ4 block compression format is detailed within [lz4_Block_format]. -Block format doesn't deal with header information, -nor how to handle arbitrarily long files or data streams. -This is the purpose of the Frame format. -Interoperable versions of LZ4 should use the same frame format, -defined into [lz4_Frame_format]. +Compressing an arbitrarily long file or data stream requires multiple blocks. +Organizing these blocks and providing a common header format to handle their content +is the purpose of the Frame format, defined into [lz4_Frame_format]. +Interoperable versions of LZ4 must respect this frame format too. [Open-Source Benchmark program by m^2 (v0.14.3)]: http://encode.ru/threads/1371-Filesystem-benchmark?p=34029&viewfull=1#post34029 [Silesia Corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia diff --git a/lz4_Frame_format.md b/lz4_Frame_format.md index 55edaa0..cb41d47 100644 --- a/lz4_Frame_format.md +++ b/lz4_Frame_format.md @@ -341,8 +341,8 @@ Data is always compressed, even when compression is detrimental. __EndMark__ -End of compressed stream is implicit. -It needs to be followed by a standard EOF (End Of File) signal, +End of legacy frame is implicit only. +It must be followed by a standard EOF (End Of File) signal, wether it is a file or a stream. Alternatively, if the frame is followed by a valid Frame Magic Number, -- cgit v0.12