Fix a few spelling and grammar errors, and two places where fast/safe in the documentation did not match the function.
Showing the changes to include/linux (1 of 1 file). Show all
Unified · Split
| @@ -278,7 +278,7 @@ int LZ4_decompress_fast(const char *source, char *dest, int originalSize); · 277 unmodified lines | |||
| 278 | * @compressedSize: is the precise full size of the compressed block | 278 | * @compressedSize: is the precise full size of the compressed block |
| 279 | * @maxDecompressedSize: is the size of 'dest' buffer | 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 | * If the source stream is detected malformed, the function will | 282 | * If the source stream is detected malformed, the function will |
| 283 | * stop decoding and return a negative result. | 283 | * stop decoding and return a negative result. |
| 284 | * This function is protected against buffer overflow exploits, | 284 | * This function is protected against buffer overflow exploits, |
| @@ -522,7 +522,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, · 237 unmodified lines | |||
| 522 | const char *dictionary, int dictSize); | 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 | * @LZ4_streamDecode: the 'LZ4_streamDecode_t' structure | 526 | * @LZ4_streamDecode: the 'LZ4_streamDecode_t' structure |
| 527 | * @source: source address of the compressed data | 527 | * @source: source address of the compressed data |
| 528 | * @dest: output buffer address of the uncompressed data | 528 | * @dest: output buffer address of the uncompressed data |
| @@ -530,7 +530,7 @@ int LZ4_setStreamDecode(LZ4_streamDecode_t *LZ4_streamDecode, · 1 unmodified line | |||
| 530 | * @compressedSize: is the precise full size of the compressed block | 530 | * @compressedSize: is the precise full size of the compressed block |
| 531 | * @maxDecompressedSize: is the size of 'dest' buffer | 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 | * in "streaming" mode. | 534 | * in "streaming" mode. |
| 535 | * Previously decoded blocks *must* remain available at the memory position | 535 | * Previously decoded blocks *must* remain available at the memory position |
| 536 | * where they were decoded (up to 64 KB) | 536 | * 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 | |||
| 569 | * which must be already allocated with 'originalSize' bytes | 569 | * which must be already allocated with 'originalSize' bytes |
| 570 | * @originalSize: is the original and therefore uncompressed size | 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 | * in "streaming" mode. | 573 | * in "streaming" mode. |
| 574 | * Previously decoded blocks *must* remain available at the memory position | 574 | * Previously decoded blocks *must* remain available at the memory position |
| 575 | * where they were decoded (up to 64 KB) | 575 | * 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 | |||
| 610 | * @dictStart: pointer to the start of the dictionary in memory | 610 | * @dictStart: pointer to the start of the dictionary in memory |
| 611 | * @dictSize: size of dictionary | 611 | * @dictSize: size of dictionary |
| 612 | * | 612 | * |
| 613 | * These decoding function works the same as | 613 | * This decoding function works the same as |
| 614 | * a combination of LZ4_setStreamDecode() followed by | 614 | * a combination of LZ4_setStreamDecode() followed by |
| 615 | * LZ4_decompress_safe_continue() | 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 | * Return: number of bytes decompressed into destination buffer | 618 | * Return: number of bytes decompressed into destination buffer |
| 619 | * (necessarily <= maxDecompressedSize) | 619 | * (necessarily <= maxDecompressedSize) |
| @@ -633,10 +633,10 @@ int LZ4_decompress_safe_usingDict(const char *source, char *dest, · 13 unmodified lines | |||
| 633 | * @dictStart: pointer to the start of the dictionary in memory | 633 | * @dictStart: pointer to the start of the dictionary in memory |
| 634 | * @dictSize: size of dictionary | 634 | * @dictSize: size of dictionary |
| 635 | * | 635 | * |
| 636 | * These decoding function works the same as | 636 | * This decoding function works the same as |
| 637 | * a combination of LZ4_setStreamDecode() followed by | 637 | * a combination of LZ4_setStreamDecode() followed by |
| 638 | * LZ4_decompress_safe_continue() | 638 | * LZ4_decompress_fast_continue() |
| 639 | * It is stand-alone, and don'tn eed a LZ4_streamDecode_t structure. | 639 | * It is stand-alone, and doesn't need an LZ4_streamDecode_t structure. |
| 640 | * | 640 | * |
| 641 | * Return: number of bytes decompressed into destination buffer | 641 | * Return: number of bytes decompressed into destination buffer |
| 642 | * (necessarily <= maxDecompressedSize) | 642 | * (necessarily <= maxDecompressedSize) |