proposed a minor change to LZ4 Frame format specification
authorYann Collet <cyan@fb.com>
Wed, 31 Jan 2018 01:53:00 +0000 (17:53 -0800)
committerYann Collet <cyan@fb.com>
Wed, 31 Jan 2018 01:56:03 +0000 (17:56 -0800)
add new terms "LZ4 Frame Header" and "LZ4 Frame Footer"

doc/lz4_Frame_format.md

index 77454b2..359e563 100644 (file)
@@ -16,7 +16,7 @@ Distribution of this document is unlimited.
 
 ### Version
 
-1.6.0 (08/08/2017)
+1.6.1 (30/01/2018)
 
 
 Introduction
@@ -72,12 +72,15 @@ Value : 0x184D2204
 
 __Frame Descriptor__
 
-3 to 15 Bytes, to be detailed in the next part.
-Most important part of the spec.
+3 to 15 Bytes, to be detailed in its own paragraph,
+as it is the most important part of the spec.
+
+The combined __Magic Number__ and __Frame Descriptor__ fields are sometimes
+called ___LZ4 Frame Header___. Its size vary between 7 and 19 bytes.
 
 __Data Blocks__
 
-To be detailed later on.
+To be detailed in its own paragraph.
 That’s where compressed data is stored.
 
 __EndMark__
@@ -98,6 +101,9 @@ that all blocks were fully transmitted in the correct order and without error,
 and also that the encoding/decoding process itself generated no distortion.
 Its usage is recommended.
 
+The combined __EndMark__ and __Content Checksum__ fields might sometimes be
+referred as ___LZ4 Frame Footer___. Its size vary between 4 and 8 bytes.
+
 __Frame Concatenation__
 
 In some circumstances, it may be preferable to append multiple frames,
@@ -380,6 +386,8 @@ and trigger an error if it does not fit within acceptable range.
 Version changes
 ---------------
 
+1.6.1 : introduced terms "LZ4 Frame Header" and "LZ4 Frame Footer"
+
 1.6.0 : restored Dictionary ID field in Frame header
 
 1.5.1 : changed document format to MarkDown