lz4_Block_format.md: clarify on short inputs and restrictions
authorAlexey Tourbin <alexey.tourbin@gmail.com>
Tue, 24 Apr 2018 22:40:12 +0000 (01:40 +0300)
committerAlexey Tourbin <alexey.tourbin@gmail.com>
Tue, 24 Apr 2018 23:39:28 +0000 (02:39 +0300)
commitff9b4cf82678f9643d256129d06098b692072584
tree0787ff85c4b04d6cdc1d1860ff555c6f94da0c24
parent62d7cdcc741480842a0c217df7cb26ad3946ab32
lz4_Block_format.md: clarify on short inputs and restrictions

It occurred to me that the formula "The last 5 bytes are always
literals", on the list of "assumptions made by the decoder", is
remarkably ambiguous.  Suppose the decoder is presented with 5 bytes.
Are they literals?  It may seem that the decoder degenerates
to memcpy on short inputs.  But of course the answer is no,
so the formula needs some clarification.

Parsing restrictions should be explained as well, otherwise they look
like arbitrary numbers.  The 5-byte restriction has been mentioned
recently in connection with the shortcut in LZ4_decompress_generic,
so I add that.  The second restriction is left to be explained
by the author.

I also took the liberty to explain that empty inputs "are either
unrepresentable or can be represented with a null byte".  This wording
may actually have some merit: it leaves for the implementation,
as opposed to the spec, to decide whether the encoder can compress
empty inputs, and whether the decoder can produce an empty output
(which the implementation should further clarify).
doc/lz4_Block_format.md