lz4: fix spelling and copy-paste errors in documentation
PATCH 1/1 lz4: fix spelling and copy-paste errors in documentation
Fix a few spelling and grammar errors, and two places where fast/safe in the documentation did not match the function.
Signed-off-by Tom Levy <[email protected]>
Cc Andrew Morton <[email protected]>
--- include/linux/lz4.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
include/linux/lz4.h +9 -9
@@ -278,7 +278,7 @@ int LZ4_decompress_fast(const char *source, char *dest, int originalSize);* @compressedSize: is the precise full size of the compressed block * @maxDecompressedSize: is the size of 'dest' buffer * -* Decompresses data fom 'source' into 'dest'. +* Decompresses data from 'source' into 'dest'. * If the source stream is detected malformed, the function will * stop decoding and return a negative result. * This function is protected against buffer overflow exploits,
@@ -522,7 +522,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, const char *dictionary, int dictSize);/** -* LZ4_decompress_fast_continue() - Decompress blocks in streaming mode +* LZ4_decompress_safe_continue() - Decompress blocks in streaming mode * @LZ4_streamDecode: the 'LZ4_streamDecode_t' structure * @source: source address of the compressed data * @dest: output buffer address of the uncompressed data
@@ -530,7 +530,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode,* @compressedSize: is the precise full size of the compressed block * @maxDecompressedSize: is the size of 'dest' buffer * -* These decoding function allows decompression of multiple blocks +* This decoding function allows decompression of multiple blocks * in "streaming" mode. * Previously decoded blocks *must* remain available at the memory position * where they were decoded (up to 64 KB)
@@ -569,7 +569,7 @@ int LZ4_decompress_safe_continue(LZ4_streamDecode_t *LZ4_streamDecode,* which must be already allocated with 'originalSize' bytes * @originalSize: is the original and therefore uncompressed size * -* These decoding function allows decompression of multiple blocks +* This decoding function allows decompression of multiple blocks * in "streaming" mode. * Previously decoded blocks *must* remain available at the memory position * where they were decoded (up to 64 KB)
@@ -610,10 +610,10 @@ int LZ4_decompress_fast_continue(LZ4_streamDecode_t *LZ4_streamDecode,* @dictStart: pointer to the start of the dictionary in memory * @dictSize: size of dictionary * -* These decoding function works the same as +* This decoding function works the same as * a combination of LZ4_setStreamDecode() followed by * LZ4_decompress_safe_continue() -* It is stand-alone, and don'tn eed a LZ4_streamDecode_t structure. +* It is stand-alone, and doesn't need an LZ4_streamDecode_t structure. * * Return: number of bytes decompressed into destination buffer * (necessarily <= maxDecompressedSize)
@@ -633,10 +633,10 @@ int LZ4_decompress_safe_usingDict(const char *source, char *dest,* @dictStart: pointer to the start of the dictionary in memory * @dictSize: size of dictionary * -* These decoding function works the same as +* This decoding function works the same as * a combination of LZ4_setStreamDecode() followed by -* LZ4_decompress_safe_continue() -* It is stand-alone, and don'tn eed a LZ4_streamDecode_t structure. +* LZ4_decompress_fast_continue() +* It is stand-alone, and doesn't need an LZ4_streamDecode_t structure. * * Return: number of bytes decompressed into destination buffer * (necessarily <= maxDecompressedSize)
Signature · 1 line
2.11.0