Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

include/linux/lz4.h: 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.

Link: http://lkml.kernel.org/r/20190321014452.13297-1-tomlevy93@gmail.com
Signed-off-by: Tom Levy <tomlevy93@gmail.com>
Reviewed-by: Andrew Morton <akpm@linux-foundation.org>
Cc: Jiri Kosina <trivial@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Tom Levy and committed by
Linus Torvalds
97a0efea a318f12e

+9 -9
+9 -9
include/linux/lz4.h
··· 278 278 * @compressedSize: is the precise full size of the compressed block 279 279 * @maxDecompressedSize: is the size of 'dest' buffer 280 280 * 281 - * Decompresses data fom 'source' into 'dest'. 281 + * Decompresses data from 'source' into 'dest'. 282 282 * If the source stream is detected malformed, the function will 283 283 * stop decoding and return a negative result. 284 284 * This function is protected against buffer overflow exploits, ··· 522 522 const char *dictionary, int dictSize); 523 523 524 524 /** 525 - * LZ4_decompress_fast_continue() - Decompress blocks in streaming mode 525 + * LZ4_decompress_safe_continue() - Decompress blocks in streaming mode 526 526 * @LZ4_streamDecode: the 'LZ4_streamDecode_t' structure 527 527 * @source: source address of the compressed data 528 528 * @dest: output buffer address of the uncompressed data ··· 530 530 * @compressedSize: is the precise full size of the compressed block 531 531 * @maxDecompressedSize: is the size of 'dest' buffer 532 532 * 533 - * These decoding function allows decompression of multiple blocks 533 + * This decoding function allows decompression of multiple blocks 534 534 * in "streaming" mode. 535 535 * Previously decoded blocks *must* remain available at the memory position 536 536 * where they were decoded (up to 64 KB) ··· 569 569 * which must be already allocated with 'originalSize' bytes 570 570 * @originalSize: is the original and therefore uncompressed size 571 571 * 572 - * These decoding function allows decompression of multiple blocks 572 + * This decoding function allows decompression of multiple blocks 573 573 * in "streaming" mode. 574 574 * Previously decoded blocks *must* remain available at the memory position 575 575 * where they were decoded (up to 64 KB) ··· 610 610 * @dictStart: pointer to the start of the dictionary in memory 611 611 * @dictSize: size of dictionary 612 612 * 613 - * These decoding function works the same as 613 + * This decoding function works the same as 614 614 * a combination of LZ4_setStreamDecode() followed by 615 615 * LZ4_decompress_safe_continue() 616 - * It is stand-alone, and don'tn eed a LZ4_streamDecode_t structure. 616 + * It is stand-alone, and doesn't need an LZ4_streamDecode_t structure. 617 617 * 618 618 * Return: number of bytes decompressed into destination buffer 619 619 * (necessarily <= maxDecompressedSize) ··· 633 633 * @dictStart: pointer to the start of the dictionary in memory 634 634 * @dictSize: size of dictionary 635 635 * 636 - * These decoding function works the same as 636 + * This decoding function works the same as 637 637 * a combination of LZ4_setStreamDecode() followed by 638 - * LZ4_decompress_safe_continue() 639 - * It is stand-alone, and don'tn eed a LZ4_streamDecode_t structure. 638 + * LZ4_decompress_fast_continue() 639 + * It is stand-alone, and doesn't need an LZ4_streamDecode_t structure. 640 640 * 641 641 * Return: number of bytes decompressed into destination buffer 642 642 * (necessarily <= maxDecompressedSize)