summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* updated documentation in anticipation for `v1.9.4` releaseYann Collet2022-08-112-52/+121
|
* fix: various typosDominique Pelle2022-07-311-2/+2
|
* updated LZ4 Block Format documentationYann Collet2022-07-311-67/+144
| | | | hopefully answering concerns expressed in #792
* minor : proper interface for LZ4F_getBlockSize()Yann Collet2022-07-132-41/+26
| | | | | and proper documentation. Also : updated manual
* minor frame format clarificationYann Collet2022-07-101-2/+1
| | | | no need to specify that a decoder can "ignore the checksum".
* review: fix findingsAlexander Mohr2022-07-051-0/+1
| | | | | | | | | * replace assert with test for LZ4F_uncompressedUpdate * update documentation to incldue correct docstring * remove unecessary entry point * remove compress_linked_block_mode from fuzzing test Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
* uncompressed-api: allow uncompressed_update only for independent blocksAlexander Mohr2022-07-051-12/+0
| | | | Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
* dict-size: make lz4 context constAlexander Mohr2022-06-111-1/+1
| | | | | change the context to const to make clear that the context is not modified
* review: Fix review findingsAlexander Mohr2022-06-101-23/+24
| | | | | | This commit fixes the review findings Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
* review: Fix review findingsAlexander Mohr2022-06-102-12/+37
| | | | | | This commit fixes the review findings Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
* frame-api: add method to insert uncomressed dataAlexander Mohr2022-06-091-0/+5
| | | | | | | | new method `uncompressed_update` allows to insert blocks without compression into the lz4 stream. The usage is documented in the frameCompress example Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
* update library version to v1.9.4Yann Collet2022-04-172-9/+9
| | | | to reduce confusion in traces between dev branch and latest v1.9.3 release.
* updated block format documentationYann Collet2022-02-021-30/+41
| | | | | | to specifically call attention to offset==0 scenario, which is invalid, and could lead to some form of security issue if incorrectly dealt with (ignored).
* Update lz4_Block_format.mdFrank Wessels2021-10-251-1/+1
| | | Mini typo
* Merge pull request #1022 from lz4/unameYann Collet2021-09-202-5/+5
|\ | | | | make UNAME externally definable
| * make UNAME externally definableYann Collet2021-08-162-5/+5
| | | | | | | | | | | | | | on top of providing a central definition place, which eases maintenance, it might also help for #1021. Also : updated doc
* | fix spellinga13460542021-08-211-4/+4
|/
* updated license & header datesYann Collet2020-11-252-2/+3
|
* update docYann Collet2020-11-151-2/+2
|
* update obsolete section documentationYann Collet2020-11-082-26/+43
| | | | | and update manuals. fix #712
* bump version numberYann Collet2020-09-292-25/+47
| | | | to v1.9.3
* clarify endMark definitionYann Collet2020-08-141-4/+4
|
* Clarifies and fix EndMarkYann Collet2020-08-131-18/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | EndMark, the 4-bytes value indicating the end of frame, must be `0x00000000`. Previously, it was just mentioned as a `0-size` block. But such definition could encompass uncompressed blocks of size 0, with a header of value `0x80000000`. But the intention was to also support uncompressed empty blocks. They could be used as a keep-alive signal. Note that compressed empty blocks are already supported, it's just that they have a size 1 instead of 0 (for the `0` token). Unfortunately, the decoder implementation was also wrong, and would also interpret a `0x80000000` block header as an endMark. This issue evaded detection so far simply because this situation never happens, as LZ4Frame always issues a clean 0x00000000 value as a endMark. It also does not flush empty blocks. This is fixed in this PR. The decoder can now deal with empty uncompressed blocks, and do not confuse them with EndMark. The specification is also clarified. Finally, FrameTest is updated to randomly insert empty blocks during fuzzing.
* bumped version number to v1.9.2Yann Collet2019-07-012-4/+4
| | | | to reduce risks that future bug reports in `dev` branch report `v1.9.1` as the failing version.
* precise again that LZ4 decoder needs metadataYann Collet2019-06-061-20/+31
| | | | and that such metadata must be provided / sent / saved by the application.
* added more details for in-place documentationYann Collet2019-05-311-12/+13
|
* updated API manualYann Collet2019-05-301-1/+1
|
* add more doc on in-place (de)compressionYann Collet2019-05-301-5/+25
|
* added comments and macros for in-place (de)compressionYann Collet2019-05-291-2/+36
|
* bumped version numberYann Collet2019-04-192-4/+4
| | | | to v1.9.1
* address a few minor Visual warningsYann Collet2019-04-181-16/+13
| | | | and created target cxx17build
* 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
generated by cgit v0.12 at 2024-11-16 20:51:21 (GMT)