Comment the lack of real_LZ4_uncompress()

Added several comments regarding the removal of real_LZ4_uncompress()
which exists in the reference implementation but has been removed here
since it's not used.

Signed-off-by: Richard Yao <ryao@gentoo.org>
Signed-off-by: Tim Chase <tim@chase2k.com>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
This commit is contained in:
Tim Chase 2014-06-28 09:08:44 -05:00 committed by Brian Behlendorf
parent d4aae2a054
commit 4240dc332d

View File

@ -115,6 +115,8 @@ lz4_decompress_zfs(void *s_start, void *d_start, size_t s_len,
* writes beyond dest + osize, and is therefore protected * writes beyond dest + osize, and is therefore protected
* against malicious data packets. * against malicious data packets.
* note : destination buffer must be already allocated * note : destination buffer must be already allocated
* note : real_LZ4_uncompress() is not used in ZFS so its code
* is not present here.
* *
* Advanced Functions * Advanced Functions
* *
@ -866,6 +868,9 @@ real_LZ4_compress(const char *source, char *dest, int isize, int osize)
* it will never read outside of the input buffer. A corrupted input * it will never read outside of the input buffer. A corrupted input
* will produce an error result, a negative int, indicating the position * will produce an error result, a negative int, indicating the position
* of the error within input stream. * of the error within input stream.
*
* Note[2]: real_LZ4_uncompress(), referred to above, is not used in ZFS so
* its code is not present here.
*/ */
static int static int