← Back to branch summary

~mmach/netext73/lz4

« back to all changes in this revision

Viewing changes to tests/README.md

  • Committer: mmach
  • Date: 2022-11-09 18:52:10 UTC
  • Revision ID: netbit73@gmail.com-20221109185210-w358idlhh0phq688
1.9.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/README.md
13
13
#### `test-lz4-versions.py` - script for testing lz4 interoperability between versions
14
14
 
15
15
This script creates `versionsTest` directory to which lz4 repository is cloned.
16
 
Then all taged (released) versions of lz4 are compiled.
 
16
Then all tagged (released) versions of lz4 are compiled.
17
17
In the following step interoperability between lz4 versions is checked.
18
18
 
19
19
 
25
25
If a new commit is found it is compiled and a speed benchmark for this commit is performed.
26
26
The results of the speed benchmark are compared to the previous results.
27
27
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.
28
 
If second results are also lower than `lowerLimit` the warning e-mail is send to recipients from the list (the `emails` parameter).
 
28
If second results are also lower than `lowerLimit` the warning e-mail is sent to recipients from the list (the `emails` parameter).
29
29
 
30
30
Additional remarks:
31
31
- 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
37
37
The example usage with two test files, one e-mail address, and with an additional message:
38
38
```
39
39
./test-lz4-speed.py "silesia.tar calgary.tar" "email@gmail.com" --message "tested on my laptop" --sleepTime 60
40
 
``` 
 
40
```
41
41
 
42
42
To run the script in background please use:
43
43
```