summaryrefslogtreecommitdiffstats
path: root/doc/lz4_manual.html
Commit message (Collapse)AuthorAgeFilesLines
* updated documentation in anticipation for `v1.9.4` releaseYann Collet2022-08-111-4/+43
|
* minor : proper interface for LZ4F_getBlockSize()Yann Collet2022-07-131-37/+14
| | | | | and proper documentation. Also : updated manual
* update library version to v1.9.4Yann Collet2022-04-171-6/+6
| | | | to reduce confusion in traces between dev branch and latest v1.9.3 release.
* make UNAME externally definableYann Collet2021-08-161-2/+2
| | | | | | | on top of providing a central definition place, which eases maintenance, it might also help for #1021. Also : updated doc
* update obsolete section documentationYann Collet2020-11-081-24/+39
| | | | | and update manuals. fix #712
* bump version numberYann Collet2020-09-291-22/+44
| | | | to v1.9.3
* bumped version number to v1.9.2Yann Collet2019-07-011-2/+2
| | | | 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-191-2/+2
| | | | 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-111-3/+8
|
* introduce LZ4_DISTANCE_MAX build macroYann Collet2019-04-111-0/+1
| | | | | | | | | | 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
* 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-041-26/+39
| | | | 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 code documentationYann Collet2018-10-151-10/+15
| | | | to clarify #589
* changed LZ4_streamDecode member orderYann Collet2018-09-251-10/+10
| | | | to reduce memory usage on 128-bits systems
* unpublish static-only functionYann Collet2018-09-131-68/+63
| | | | | | | 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
* updated function interface documentationYann Collet2018-09-071-38/+67
|
* updated documentation regarding dictionary compressionYann Collet2018-09-051-3/+3
| | | | | | 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
|
* 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.
* ensure favorDecSpeed is properly initializedYann Collet2018-04-271-5/+7
| | | | | | | also : - fix a potential malloc error - proper use of ALLOC macro inside lz4hc - update html API doc
* 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
* bumped version number to v1.8.2Yann Collet2018-02-261-2/+2
| | | | 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
* refactored frameCompress exampleYann Collet2018-01-311-2/+2
| | | | to better reflect LZ4F API usage.
* nicer console message for `make clean`Yann Collet2018-01-141-2/+2
|
* 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
* fixed gcc prototype warningYann Collet2017-08-101-4/+0
|
* dictionary compression correctly uses compression levelYann Collet2017-08-101-16/+20
| | | | Not obvious : copying the state was copying cdict's compression level
* implemented dictionary compression in lz4frameYann Collet2017-08-091-1/+1
| | | | | note : only compression API is implemented and tested still to do : decompression API
* bumped version number to 1.8.0Yann Collet2017-05-101-2/+2
| | | | | due to addition of prototype LZ4F_resetDecompressionContext()
* updated MakefileYann Collet2017-05-101-9/+9
| | | | | to automatically build manual files with make all
* lz4 manual updated to v1.7.5Przemyslaw Skibinski2017-01-231-89/+126
|
* Expose internal types to remove strict aliasingNick Terrell2016-11-111-10/+58
|
* added lz4_manual.htmlPrzemyslaw Skibinski2016-11-101-0/+240