Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: various typos #1125

Merged
merged 1 commit into from
Jul 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If applicable, add screenshots to help explain your problem.
- Version [e.g. 22]
- Compiler [e.g. gcc]
- Build System [e.g. Makefile]
- Other hardware specs [e.g Core 2 duo...]
- Other hardware specs [e.g. Core 2 duo...]

**Additional context**
Add any other context about the problem here.
2 changes: 1 addition & 1 deletion .github/workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This directory contains [GitHub Actions](https://github.com/features/actions) wo
## USAN, ASAN (`lz4-ubsan-x64`, `lz4-ubsan-x86`, `lz4-asan-x64`)

For now, `lz4-ubsan-*` ignores the exit code of `make usan` and `make usan32`.
Because there're several issues which may take relatively long time to resolve.
Because there are several issues which may take relatively long time to resolve.

We'll fully enable it when we ensure `make usan` is ready for all commits and PRs.

Expand Down
2 changes: 1 addition & 1 deletion contrib/snap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ of lz4. Snaps are universal Linux packages that allow you to easily
build your application from any source and ship it to any Linux
distribution by publishing it to https://snapcraft.io/. A key attribute
of a snap package is that it is (ideally) confined such that it
executes within a controlled environmenti with all its dependencies
executes within a controlled environment with all its dependencies
bundled with it and does not share dependencies with of from any other
package on the system (with a couple of minor exceptions).

Expand Down
4 changes: 2 additions & 2 deletions doc/lz4_Block_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Example 2 : A literal length of 280 will be represented as :

- 15 : value for the 4-bits High field
- 255 : following byte is maxed, since 280-15 >= 255
- 10 : (=280 - 15 - 255) ) remaining length to reach 280
- 10 : (=280 - 15 - 255) remaining length to reach 280

Example 3 : A literal length of 15 will be represented as :

Expand Down Expand Up @@ -239,6 +239,6 @@ searches and selects matches within the source data block.
For example, an upper compression limit can be reached,
using a technique called "full optimal parsing", at high cpu and memory cost.
But multiple other techniques can be considered,
featuring distinct time / performance trade offs.
featuring distinct time / performance trade-offs.
As long as the specified format is respected,
the result will be compatible with and decodable by any compliant decoder.
4 changes: 2 additions & 2 deletions examples/blockStreaming_lineByLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ This is called "External Dictionary Mode".
In Line#X+2 (see (5)), finally LZ4 forget almost all memories but still remains Line#X+1.
This is the same situation as Line#2.

Continue these procedure to the end of text file.
Continue these procedures to the end of text file.


## How the decompression works
Expand All @@ -119,4 +119,4 @@ Decompression will do reverse order.
- Output decompressed plain text line to the file.
- Forward ringbuffer offset. If offset exceeds end of the ringbuffer, reset it.

Continue these procedure to the end of the compressed file.
Continue these procedures to the end of the compressed file.
2 changes: 1 addition & 1 deletion examples/dictionaryRandomAccess.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ Decompression will do reverse order.
- Read the next block.
- Decompress it and write that page to the file.

Continue these procedure until all the required data has been read.
Continue these procedures until all the required data has been read.
2 changes: 1 addition & 1 deletion examples/streaming_api_basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ LZ4 has the following API sets :
It guarantees interoperability with other LZ4 framing format compliant tools/libraries
such as LZ4 command line utility, node-lz4, etc.
- "Block" API : This is recommended for simple purpose.
It compress single raw memory block to LZ4 memory block and vice versa.
It compresses single raw memory block to LZ4 memory block and vice versa.
- "Streaming" API : This is designed for complex things.
For example, compress huge stream data in restricted memory environment.

Expand Down
2 changes: 1 addition & 1 deletion lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The following build macro can be selected to adjust source code behavior at comp
by using bitcount instructions, generally implemented as fast single instructions in many cpus.
In case the target cpus doesn't support it, or compiler intrinsic doesn't work, or feature bad performance,
it's possible to use an optimized software path instead.
This is achieved by setting this build macros .
This is achieved by setting this build macros.
In most cases, it's not expected to be necessary,
but it can be legitimately considered for less common platforms.

Expand Down
2 changes: 1 addition & 1 deletion lib/dll/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The compiled executable will require LZ4 DLL which is available at `dll\msys-lz4
Open `example\fullbench-dll.sln` to compile `fullbench-dll` that uses a
dynamic LZ4 library from the `dll` directory. The solution works with Visual C++
2010 or newer. When one will open the solution with Visual C++ newer than 2010
then the solution will upgraded to the current version.
then the solution will be upgraded to the current version.


#### Using LZ4 DLL with Visual C++
Expand Down
2 changes: 1 addition & 1 deletion lib/lz4.c
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ static unsigned LZ4_NbCommonBytes (reg_t val)
* including _tzcnt_u64. Therefore, we need to neuter the _tzcnt_u64 code path for ARM64EC.
****************************************************************************************************/
# if defined(__clang__) && (__clang_major__ < 10)
/* Avoid undefined clang-cl intrinics issue.
/* Avoid undefined clang-cl intrinsics issue.
* See https://github.com/lz4/lz4/pull/1017 for details. */
return (unsigned)__builtin_ia32_tzcnt_u64(val) >> 3;
# else
Expand Down
2 changes: 1 addition & 1 deletion programs/bench.c
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ static int BMK_benchMem(const void* srcBuffer, size_t srcSize,
remaining -= thisBlockSize;
} } }

/* warmimg up memory */
/* warming up memory */
RDG_genBuffer(compressedBuffer, maxCompressedSize, 0.10, 0.50, 1);

/* decode-only mode : copy input to @compressedBuffer */
Expand Down
2 changes: 1 addition & 1 deletion programs/lz4cli.c
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ static int usage_longhelp(const char* exeName)
DISPLAY( "\n");
DISPLAY( "Compression levels : \n");
DISPLAY( "---------------------\n");
DISPLAY( "-0 ... -2 => Fast compression, all identicals\n");
DISPLAY( "-0 ... -2 => Fast compression, all identical\n");
DISPLAY( "-3 ... -%d => High compression; higher number == more compression but slower\n", LZ4HC_CLEVEL_MAX);
DISPLAY( "\n");
DISPLAY( "stdin, stdout and the console : \n");
Expand Down
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ After `sleepTime` (an optional parameter, default 300 seconds) seconds the scrip
If a new commit is found it is compiled and a speed benchmark for this commit is performed.
The results of the speed benchmark are compared to the previous results.
If compression or decompression speed for one of lz4 levels is lower than `lowerLimit` (an optional parameter, default 0.98) the speed benchmark is restarted.
If second results are also lower than `lowerLimit` the warning e-mail is send to recipients from the list (the `emails` parameter).
If second results are also lower than `lowerLimit` the warning e-mail is sent to recipients from the list (the `emails` parameter).

Additional remarks:
- To be sure that speed results are accurate the script should be run on a "stable" target system with no other jobs running in parallel
Expand Down