From fd0c125ff1c7962f6ec2567718ffa576aa4248a8 Mon Sep 17 00:00:00 2001
From: Yann Collet <cyan@fb.com>
Date: Tue, 30 Jan 2018 17:53:00 -0800
Subject: proposed a minor change to LZ4 Frame format specification

add new terms "LZ4 Frame Header" and "LZ4 Frame Footer"
---
 doc/lz4_Frame_format.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/lz4_Frame_format.md b/doc/lz4_Frame_format.md
index 77454b2..359e563 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 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
-- 
cgit v0.12


From d03224b63345d4ace45c56773f456da16e6c0acd Mon Sep 17 00:00:00 2001
From: Yann Collet <cyan@fb.com>
Date: Wed, 31 Jan 2018 09:54:30 -0800
Subject: fix typos as suggested by @psteinb

---
 doc/lz4_Frame_format.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/lz4_Frame_format.md b/doc/lz4_Frame_format.md
index 359e563..0c98df1 100644
--- a/doc/lz4_Frame_format.md
+++ b/doc/lz4_Frame_format.md
@@ -76,7 +76,7 @@ __Frame Descriptor__
 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.
+called ___LZ4 Frame Header___. Its size varies between 7 and 19 bytes.
 
 __Data Blocks__
 
@@ -102,7 +102,7 @@ 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.
+referred to as ___LZ4 Frame Footer___. Its size varies between 4 and 8 bytes.
 
 __Frame Concatenation__
 
-- 
cgit v0.12