summaryrefslogtreecommitdiffstats
path: root/doc/lz4_Frame_format.md
diff options
context:
space:
mode:
authorYann Collet <Cyan4973@users.noreply.github.com>2018-05-07 21:38:45 (GMT)
committerGitHub <noreply@github.com>2018-05-07 21:38:45 (GMT)
commitb3692db46d2b23a7c0af2d5e69988c94f126e10a (patch)
treed9aa14d72978e78a1ca2f1aee99511ce2d04293c /doc/lz4_Frame_format.md
parentdfed9fa1d77f0434306d377c4da1f7191d3ba08a (diff)
parentbf6fd938e522150e2a30bee978102769a51f4b3e (diff)
downloadlz4-b3692db46d2b23a7c0af2d5e69988c94f126e10a.zip
lz4-b3692db46d2b23a7c0af2d5e69988c94f126e10a.tar.gz
lz4-b3692db46d2b23a7c0af2d5e69988c94f126e10a.tar.bz2
Merge pull request #531 from lz4/devv1.8.2
Preparing v1.8.2
Diffstat (limited to 'doc/lz4_Frame_format.md')
-rw-r--r--doc/lz4_Frame_format.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/lz4_Frame_format.md b/doc/lz4_Frame_format.md
index 77454b2..0c98df1 100644
--- a/doc/lz4_Frame_format.md
+++ b/doc/lz4_Frame_format.md
@@ -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 varies 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 to as ___LZ4 Frame Footer___. Its size varies 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