[pcsx_rearmed.git] / deps / libchdr / deps / zstd-1.5.5 / tests / regression / README.md

# Regression tests

The regression tests run zstd in many scenarios and ensures that the size of the compressed results doesn't change. This helps us ensure that we don't accidentally regress zstd's compression ratio.

These tests get run every night by CircleCI. If the job fails you can read the diff printed by the job to ensure the change isn't a regression. If all is well you can download the `results.csv` artifact and commit the new results. Or you can rebuild it yourself following the instructions below.

## Rebuilding results.csv

From the root of the zstd repo run:

```
# Build the zstd binary
make clean
make -j zstd

# Build the regression test binary
cd tests/regression
make clean
make -j test

# Run the regression test
./test --cache data-cache --zstd ../../zstd --output results.csv

# Check results.csv to ensure the new results are okay
git diff

# Then submit the PR
```
Commit	Line	Data
648db22b	1	# Regression tests
	2
	3	The regression tests run zstd in many scenarios and ensures that the size of the compressed results doesn't change. This helps us ensure that we don't accidentally regress zstd's compression ratio.
	4
	5	These tests get run every night by CircleCI. If the job fails you can read the diff printed by the job to ensure the change isn't a regression. If all is well you can download the `results.csv` artifact and commit the new results. Or you can rebuild it yourself following the instructions below.
	6
	7	## Rebuilding results.csv
	8
	9	From the root of the zstd repo run:
	10
	11	```
	12	# Build the zstd binary
	13	make clean
	14	make -j zstd
	15
	16	# Build the regression test binary
	17	cd tests/regression
	18	make clean
	19	make -j test
	20
	21	# Run the regression test
	22	./test --cache data-cache --zstd ../../zstd --output results.csv
	23
	24	# Check results.csv to ensure the new results are okay
	25	git diff
	26
	27	# Then submit the PR
	28	```