From 51be2943b3d1aef5d1a962ff247ee5309864f830 Mon Sep 17 00:00:00 2001 From: Qi Wang Date: Sun, 5 Jun 2022 16:21:26 +0800 Subject: docs: fix some typo Signed-off-by: Qi Wang --- examples/compress_functions.c | 2 +- examples/simple_buffer.c | 2 +- examples/streaming_api_basics.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/compress_functions.c b/examples/compress_functions.c index e27c612..2a9d124 100644 --- a/examples/compress_functions.c +++ b/examples/compress_functions.c @@ -48,7 +48,7 @@ * Special Note About Decompression: * Using the LZ4_decompress_safe() function protects against malicious (user) input. If you are using data from a * trusted source, or if your program is the producer (P) as well as its consumer (C) in a PC or MPMC setup, you can - * safely use the LZ4_decompress_fast function + * safely use the LZ4_decompress_fast function. */ /* Since lz4 compiles with c99 and not gnu/std99 we need to enable POSIX linking for time.h structs and functions. */ diff --git a/examples/simple_buffer.c b/examples/simple_buffer.c index c7d59e3..f5c6eb2 100644 --- a/examples/simple_buffer.c +++ b/examples/simple_buffer.c @@ -47,7 +47,7 @@ int main(void) { char* compressed_data = (char*)malloc((size_t)max_dst_size); if (compressed_data == NULL) run_screaming("Failed to allocate memory for *compressed_data.", 1); - // That's all the information and preparation LZ4 needs to compress *src into *compressed_data. + // That's all the information and preparation LZ4 needs to compress *src into* compressed_data. // Invoke LZ4_compress_default now with our size values and pointers to our memory locations. // Save the return value for error checking. const int compressed_data_size = LZ4_compress_default(src, compressed_data, src_size, max_dst_size); diff --git a/examples/streaming_api_basics.md b/examples/streaming_api_basics.md index 1ccc6e3..abffaef 100644 --- a/examples/streaming_api_basics.md +++ b/examples/streaming_api_basics.md @@ -22,7 +22,7 @@ But if you want to write advanced application, it's time to use Block or Streami Block API (de)compresses a single contiguous memory block. In other words, LZ4 library finds redundancy from a single contiguous memory block. Streaming API does same thing but (de)compresses multiple adjacent contiguous memory blocks. -So LZ4 library could find more redundancy than Block API. +So Streaming API could find more redundancy than Block API. The following figure shows difference between API and block sizes. In these figures, the original data is split into 4KiBytes contiguous chunks. -- cgit v0.12