History

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.

Tom Levy committed 7 years ago

Commit 97a0efe1 parent a318f121 file · +9 −9Browse files

Showing the changes to include/linux (1 of 1 file). Show all

Unified · Split

include/linux/lz4.h+9−9
@@ -278,7 +278,7 @@ int LZ4_decompress_fast(const char *source, char *dest, int originalSize); · 277 unmodified lines
278278 * @compressedSize: is the precise full size of the compressed block
279279 * @maxDecompressedSize: is the size of 'dest' buffer
280280 *
281− * Decompresses data fom 'source' into 'dest'.
281+ * Decompresses data from 'source' into 'dest'.
282282 * If the source stream is detected malformed, the function will
283283 * stop decoding and return a negative result.
284284 * This function is protected against buffer overflow exploits,
@@ -522,7 +522,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, · 237 unmodified lines
522522 const char *dictionary, int dictSize);
523523
524524 /**
525− * LZ4_decompress_fast_continue() - Decompress blocks in streaming mode
525+ * LZ4_decompress_safe_continue() - Decompress blocks in streaming mode
526526 * @LZ4_streamDecode: the 'LZ4_streamDecode_t' structure
527527 * @source: source address of the compressed data
528528 * @dest: output buffer address of the uncompressed data
@@ -530,7 +530,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, · 1 unmodified line
530530 * @compressedSize: is the precise full size of the compressed block
531531 * @maxDecompressedSize: is the size of 'dest' buffer
532532 *
533− * These decoding function allows decompression of multiple blocks
533+ * This decoding function allows decompression of multiple blocks
534534 * in "streaming" mode.
535535 * Previously decoded blocks *must* remain available at the memory position
536536 * where they were decoded (up to 64 KB)
@@ -569,7 +569,7 @@ int LZ4_decompress_safe_continue(LZ4_streamDecode_t *LZ4_streamDecode, · 32 unmodified lines
569569 * which must be already allocated with 'originalSize' bytes
570570 * @originalSize: is the original and therefore uncompressed size
571571 *
572− * These decoding function allows decompression of multiple blocks
572+ * This decoding function allows decompression of multiple blocks
573573 * in "streaming" mode.
574574 * Previously decoded blocks *must* remain available at the memory position
575575 * where they were decoded (up to 64 KB)
@@ -610,10 +610,10 @@ int LZ4_decompress_fast_continue(LZ4_streamDecode_t *LZ4_streamDecode, · 34 unmodified lines
610610 * @dictStart: pointer to the start of the dictionary in memory
611611 * @dictSize: size of dictionary
612612 *
613− * These decoding function works the same as
613+ * This decoding function works the same as
614614 * a combination of LZ4_setStreamDecode() followed by
615615 * 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.
617617 *
618618 * Return: number of bytes decompressed into destination buffer
619619 * (necessarily <= maxDecompressedSize)
@@ -633,10 +633,10 @@ int LZ4_decompress_safe_usingDict(const char *source, char *dest, · 13 unmodified lines
633633 * @dictStart: pointer to the start of the dictionary in memory
634634 * @dictSize: size of dictionary
635635 *
636− * These decoding function works the same as
636+ * This decoding function works the same as
637637 * 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.
640640 *
641641 * Return: number of bytes decompressed into destination buffer
642642 * (necessarily <= maxDecompressedSize)

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t