aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/snappy/README.md
diff options
context:
space:
mode:
authorthegeorg <thegeorg@yandex-team.ru>2022-05-17 12:11:49 +0300
committerthegeorg <thegeorg@yandex-team.ru>2022-05-17 12:11:49 +0300
commit2037874aa0fb0efca88322b14290deab89fccbd4 (patch)
tree8a9d856da3ea564b9e06914a56f7f4dacb0e75f7 /contrib/libs/snappy/README.md
parent7c645e66a7bdae9d6c54d50bf87259c4ffc33e5b (diff)
downloadydb-2037874aa0fb0efca88322b14290deab89fccbd4.tar.gz
Update contrib/libs/snappy to 1.1.9
ref:8e094c2e0f44b866d354257c6a902b6d4394b8f0
Diffstat (limited to 'contrib/libs/snappy/README.md')
-rw-r--r--contrib/libs/snappy/README.md54
1 files changed, 23 insertions, 31 deletions
diff --git a/contrib/libs/snappy/README.md b/contrib/libs/snappy/README.md
index cef4017492..7917d1bf05 100644
--- a/contrib/libs/snappy/README.md
+++ b/contrib/libs/snappy/README.md
@@ -1,5 +1,7 @@
Snappy, a fast compressor/decompressor.
+[![Build Status](https://travis-ci.org/google/snappy.svg?branch=master)](https://travis-ci.org/google/snappy)
+[![Build status](https://ci.appveyor.com/api/projects/status/t9nubcqkwo8rw8yn/branch/master?svg=true)](https://ci.appveyor.com/project/pwnall/leveldb)
Introduction
============
@@ -69,6 +71,7 @@ You need the CMake version specified in [CMakeLists.txt](./CMakeLists.txt)
or later to build:
```bash
+git submodule update --init
mkdir build
cd build && cmake ../ && make
```
@@ -107,42 +110,31 @@ information.
Tests and benchmarks
====================
-When you compile Snappy, snappy_unittest is compiled in addition to the
-library itself. You do not need it to use the compressor from your own library,
-but it contains several useful components for Snappy development.
+When you compile Snappy, the following binaries are compiled in addition to the
+library itself. You do not need them to use the compressor from your own
+library, but they are useful for Snappy development.
-First of all, it contains unit tests, verifying correctness on your machine in
-various scenarios. If you want to change or optimize Snappy, please run the
-tests to verify you have not broken anything. Note that if you have the
-Google Test library installed, unit test behavior (especially failures) will be
-significantly more user-friendly. You can find Google Test at
+* `snappy_benchmark` contains microbenchmarks used to tune compression and
+ decompression performance.
+* `snappy_unittests` contains unit tests, verifying correctness on your machine
+ in various scenarios.
+* `snappy_test_tool` can benchmark Snappy against a few other compression
+ libraries (zlib, LZO, LZF, and QuickLZ), if they were detected at configure
+ time. To benchmark using a given file, give the compression algorithm you want
+ to test Snappy against (e.g. --zlib) and then a list of one or more file names
+ on the command line.
- https://github.com/google/googletest
+If you want to change or optimize Snappy, please run the tests and benchmarks to
+verify you have not broken anything.
-You probably also want the gflags library for handling of command-line flags;
-you can find it at
-
- https://gflags.github.io/gflags/
-
-In addition to the unit tests, snappy contains microbenchmarks used to
-tune compression and decompression performance. These are automatically run
-before the unit tests, but you can disable them using the flag
---run_microbenchmarks=false if you have gflags installed (otherwise you will
-need to edit the source).
-
-Finally, snappy can benchmark Snappy against a few other compression libraries
-(zlib, LZO, LZF, and QuickLZ), if they were detected at configure time.
-To benchmark using a given file, give the compression algorithm you want to test
-Snappy against (e.g. --zlib) and then a list of one or more file names on the
-command line. The testdata/ directory contains the files used by the
-microbenchmark, which should provide a reasonably balanced starting point for
-benchmarking. (Note that baddata[1-3].snappy are not intended as benchmarks; they
-are used to verify correctness in the presence of corrupted data in the unit
-test.)
+The testdata/ directory contains the files used by the microbenchmarks, which
+should provide a reasonably balanced starting point for benchmarking. (Note that
+baddata[1-3].snappy are not intended as benchmarks; they are used to verify
+correctness in the presence of corrupted data in the unit test.)
Contact
=======
-Snappy is distributed through GitHub. For the latest version, a bug tracker,
-and other information, see https://github.com/google/snappy.
+Snappy is distributed through GitHub. For the latest version and other
+information, see https://github.com/google/snappy.