a0483764f3
This merge brings in a couple new files, which needed to be attached to the build; a new dependency on <limits.h>, which must be stubbed; and a name change in the Context parameter constants, from ZSTD_p_foo to ZSTD_c_foo. Significantly, it fixes a kernel build error with GCC where floating-point functions were included in the kernel build, by hiding them under the same compile-time #ifdef that already covered their invocation. That issue was introduced to FreeBSD in the 1.3.7 update and tracked upstream here: https://github.com/facebook/zstd/issues/1386 The full 1.3.8 release notes can be found on Github: https://github.com/facebook/zstd/releases/tag/v1.3.8 Relnotes: yes |
||
|---|---|---|
| .. | ||
| educational_decoder | ||
| images | ||
| README.md | ||
| zstd_compression_format.md | ||
| zstd_manual.html | ||
Zstandard Documentation
This directory contains material defining the Zstandard format,
as well as detailed instructions to use zstd library.
zstd_manual.html : Documentation of zstd.h API, in html format.
Click on this link: http://zstd.net/zstd_manual.html
to display documentation of latest release in readable format within a browser.
zstd_compression_format.md : This document defines the Zstandard compression format.
Compliant decoders must adhere to this document,
and compliant encoders must generate data that follows it.
Should you look for ressources to develop your own port of Zstandard algorithm, you may find the following ressources useful :
educational_decoder : This directory contains an implementation of a Zstandard decoder,
compliant with the Zstandard compression format.
It can be used, for example, to better understand the format,
or as the basis for a separate implementation of Zstandard decoder.
decode_corpus :
This tool, stored in /tests directory, is able to generate random valid frames,
which is useful if you wish to test your decoder and verify it fully supports the specification.