zstd/doc
Yann Collet 14312d833e zstdmt : fix : loading prefix from previous segments
There used to be a (very small) chance that
loading prefix from previous segment
would be confused with a real zstd dictionary.
For that to happen, the prefix needs to start
with the same value as dictionary magic.
That's 1 chance in 4 billions if all values have equal probability.
But in fact, since some values are more common (0x00000000 for example)
others are less common, and dictionary magic was selected to be one of them,
so probabilities are likely even lower.

Anyway, this risk is no down to zero
by adding a new CCtx parameter : ZSTD_p_forceRawDict

Current parameter policy : the parameter "stick" to its CCtx,
so any dictionary loading after ZSTD_p_forceRawDict is set
will be loaded in "raw" ("content only") mode,
even if CCtx is re-used multiple times with multiple different dictionary.
It's up to the user to reset this value differently if it needs so.
2017-02-23 23:42:12 -08:00
..
educational_decoder Merge branch 'dev' into doc 2017-02-23 15:23:24 -08:00
images removed unused chart 2017-02-02 13:50:51 -08:00
README.md Move educational_decoder to doc/ and add doc README 2017-02-23 14:34:52 -08:00
zstd_compression_format.md Add default distributions and fix typos 2017-02-21 10:20:36 -08:00
zstd_manual.html zstdmt : fix : loading prefix from previous segments 2017-02-23 23:42:12 -08:00

Zstandard Documentation

This directory contains material defining the Zstandard format, as well as for help using the zstd library.

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.

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 a Zstandard decoder/encoder.

zstd_manual.html : Documentation on the functions found in zstd.h. See http://zstd.net/zstd_manual.html for the manual released with the latest official zstd release.