summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* updated doc to underline difference between block and frameYann Collet2019-04-121-7/+11
| | | | as this is a very frequent source of confusion for new users.
* improved documentation for LZ4 dictionary compressionYann Collet2019-04-112-4/+9
|
* introduce LZ4_DISTANCE_MAX build macroYann Collet2019-04-112-14/+48
| | | | | | | | | | make it possible to generate LZ4-compressed block with a controlled maximum offset (necessarily <= 65535). This could be useful for compatibility with decoders using a very limited memory budget (<64 KB). Answer #154
* updated block format with more details on MF_LIMITYann Collet2019-04-111-12/+23
| | | | aka distance from end of block for the last match.
* modified LZ4_initStreamHC() to look like LZ4_initStream()Yann Collet2019-04-091-12/+19
| | | | | it is now a pure initializer, for statically allocated states. It can initialize any memory area, and because of this, requires size.
* created LZ4_initStream()Yann Collet2019-04-051-44/+43
| | | | | | | | | | - promoted LZ4_resetStream_fast() to stable - moved LZ4_resetStream() into deprecate, but without triggering a compiler warning - update all sources to no longer rely on LZ4_resetStream() note : LZ4_initStream() proposal is slightly different : it's able to initialize any buffer, provided that it's large enough. To this end, it accepts a void*, and returns an LZ4_stream_t*.
* make `_fast*()` decoder generate a deprecation warningYann Collet2019-04-042-28/+41
| | | | updated modification
* fixed docYann Collet2019-04-031-9/+12
| | | | and bumped version number fo v1.9.0
* moved _destSize() into "stable API" statusYann Collet2019-04-031-7/+14
| | | | as requested in #642
* updated frame formatYann Collet2019-01-021-7/+10
| | | | | re-wording non-full blocks, for clarity.
* updated LZ4 block formatYann Collet2019-01-021-36/+33
| | | | | rewording the end of block conditions for clarity and answering related questions.
* Merge remote-tracking branch 'upstream/master' into bootcampBing Xu2018-11-261-1/+1
|\
| * lz4_Frame_format.md: Fix typo HexaBytes -> ExabytesNiklas Hambüchen2018-11-241-1/+1
| |
* | updated code documentationYann Collet2018-10-152-18/+29
| | | | | | | | to clarify #589
* | changed LZ4_streamDecode member orderYann Collet2018-09-251-10/+10
| | | | | | | | to reduce memory usage on 128-bits systems
* | Merge pull request #575 from lz4/apiDocYann Collet2018-09-181-65/+60
|\ \ | | | | | | unpublish static-only functions
| * | unpublish static-only functionYann Collet2018-09-132-74/+71
| | | | | | | | | | | | | | | | | | | | | these functions are now unpublished in dll by default. One needs to opt-in, using macro LZ4_PUBLISH_STATIC_FUNCTIONS. used this opportunity to update a bunch of api comments in lz4.h
* | | avoid final trailing comma for enum listsYann Collet2018-09-132-10/+13
|/ / | | | | | | | | | | | | as detected in #485 by @JoachimSchneider. Refactored the c_standards tests so that these issues get automatically detected in CI tests.
* | removed image from repositoryYann Collet2018-09-121-0/+0
|/ | | | used for v1.8.2 announcement
* updated function interface documentationYann Collet2018-09-071-38/+67
|
* updated documentation regarding dictionary compressionYann Collet2018-09-052-5/+5
| | | | | | following suggestion from @stbrumme (#558) Also : bumped version number, regenerated man page and html doc
* fixed spelling mistake in lz4_manualJack Luo2018-07-291-1/+1
|
* Added CDict speed graph to be used for release statementYann Collet2018-05-031-0/+0
|
* updated API documentationYann Collet2018-05-031-6/+20
|
* random lz4f clarificationsYann Collet2018-05-021-16/+38
| | | | | | | | | | | | | | the initial intention was to update lz4f ring buffer strategy, but lz4f doesn't use ring buffer. Instead, it uses the destination buffer as much as possible, and merely copies just what's required to preserve history into its own buffer, at the end. Pretty efficient. This patch just clarifies a few comments and add some assert(). It's built on top of #528. It also updates doc.
* Merge pull request #519 from lz4/fdParserYann Collet2018-04-272-9/+66
|\ | | | | Faster decoding speed
| * ensure favorDecSpeed is properly initializedYann Collet2018-04-272-9/+66
| | | | | | | | | | | | | | also : - fix a potential malloc error - proper use of ALLOC macro inside lz4hc - update html API doc
* | minor edit of block formatCyan49732018-04-251-28/+32
| | | | | | | | clarifying parsing restrictions near end of block.
* | lz4_Block_format.md: clarify on short inputs and restrictionsAlexey Tourbin2018-04-241-3/+12
|/ | | | | | | | | | | | | | | | | | | | | | It occurred to me that the formula "The last 5 bytes are always literals", on the list of "assumptions made by the decoder", is remarkably ambiguous. Suppose the decoder is presented with 5 bytes. Are they literals? It may seem that the decoder degenerates to memcpy on short inputs. But of course the answer is no, so the formula needs some clarification. Parsing restrictions should be explained as well, otherwise they look like arbitrary numbers. The 5-byte restriction has been mentioned recently in connection with the shortcut in LZ4_decompress_generic, so I add that. The second restriction is left to be explained by the author. I also took the liberty to explain that empty inputs "are either unrepresentable or can be represented with a null byte". This wording may actually have some merit: it leaves for the implementation, as opposed to the spec, to decide whether the encoder can compress empty inputs, and whether the decoder can produce an empty output (which the implementation should further clarify).
* minor length reduction of several large linesYann Collet2018-04-181-21/+29
|
* compatibility with gcc-4.4 string.h versionCyan49732018-04-131-22/+72
| | | | | | | Someone found it would be a great idea to define there a global variable under the very generic name "index". Cause problem with shadow warnings, so no variable can be named "index" now ... Also : automatically update API manual
* updated LZ4F_compressBound() documentationYann Collet2018-02-281-3/+6
| | | | to clarify it includes potentially buffered data.
* bumped version number to v1.8.2Yann Collet2018-02-262-4/+4
| | | | updated NEWS was current progresses
* update code comment on LZ4 streaming interfaceYann Collet2018-02-261-10/+11
| | | | | notably regarding LZ4_saveDict() speed advantage, answering #477.
* update API doc regarding double-buffer strategyYann Collet2018-02-181-1/+3
| | | | answering question #473
* fixed code comment as detected in #466Yann Collet2018-02-071-32/+33
| | | | | Also clarified a few API code comments and updated associated html documentation
* Merge pull request #458 from lz4/ff161Yann Collet2018-02-011-4/+12
|\ | | | | Minor change to LZ4 Frame format specification
| * fix typos as suggested by @psteinbYann Collet2018-01-311-2/+2
| |
| * proposed a minor change to LZ4 Frame format specificationYann Collet2018-01-311-4/+12
| | | | | | | | add new terms "LZ4 Frame Header" and "LZ4 Frame Footer"
* | refactored frameCompress exampleYann Collet2018-01-312-22/+26
|/ | | | to better reflect LZ4F API usage.
* nicer console message for `make clean`Yann Collet2018-01-142-14/+19
|
* API : changed a few variables' names for clarityYann Collet2017-11-201-43/+43
| | | | | updated relevant doc. This patch has no impact on ABI/API, nor on binary generation.
* complementary information for #394Yann Collet2017-08-301-9/+15
|
* clarified documentation of streaming decompression functionsYann Collet2017-08-301-9/+13
| | | | | (synchronous bufferless mode) answering questions by @jtbandes (#394)
* build: source files sorted in a FS independent mannerYann Collet2017-08-261-2/+4
| | | | | to be more compatible with reproducible builds. patch inspired by @bmwiedemann
* restored block checksum capability at lz4frame API levelYann Collet2017-08-121-10/+15
|
* implemented lz4frame decompression APIYann Collet2017-08-101-5/+5
|
* support dictionary compression with independent blocksYann Collet2017-08-101-27/+28
|
* fixed gcc prototype warningYann Collet2017-08-101-4/+0
|
* dictionary compression correctly uses compression levelYann Collet2017-08-102-17/+21
| | | | Not obvious : copying the state was copying cdict's compression level
generated by cgit v0.12 at 2024-11-02 14:44:06 (GMT)