Skip to content

Commit

Permalink
Add a banner to mention the data corruption bug
Browse files Browse the repository at this point in the history
Until DataDog#22 is fixed, this library is using zstd in a way that can cause data corruption, as confirmed by zstd maintainer himself. I think this is critical enough that should be mentioned at the top of README and the Go community should be alerted until the bug is fixed
  • Loading branch information
rasky authored Nov 20, 2019
1 parent 8fdb579 commit 404b9bd
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
The current headers and C files are from *v1.4.4* (Commit
[10f0e699](https://github.com/facebook/zstd/releases/tag/v1.4.4)).

# IMPORTANT NOTE: MEMORY CORRUPTION BUG

Current versions of this library have a [serious bug](https://github.com/DataDog/zstd/issues/22#issuecomment-444317542) that can cause [data corruption](https://github.com/DataDog/zstd/issues/39). Until the bug is fixed, please use an alternative library such as https://github.com/valyala/gozstd.

## Usage

There are two main APIs:
Expand Down

0 comments on commit 404b9bd

Please sign in to comment.