AuroraMiddleware/lz4
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Yann Collet 2020-11-15 01:31:09 -08:00
parent 0bd7dafc93
commit 0760724577
6 changed files with 7 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -26,25 +26,13 @@ LZ4 library is provided as open-source software using BSD 2-Clause license.
|Branch |Status | |Branch |Status |
|------------|---------| |------------|---------|
|master | [![Build Status][travisMasterBadge]][travisLink] [![Build status][AppveyorMasterBadge]][AppveyorLink] [![coverity][coverBadge]][coverlink] |
|dev | [![Build Status][travisDevBadge]][travisLink] [![Build status][AppveyorDevBadge]][AppveyorLink] | |dev | [![Build Status][travisDevBadge]][travisLink] [![Build status][AppveyorDevBadge]][AppveyorLink] |
[travisMasterBadge]: https://travis-ci.org/lz4/lz4.svg?branch=master "Continuous Integration test suite"
[travisDevBadge]: https://travis-ci.org/lz4/lz4.svg?branch=dev "Continuous Integration test suite" [travisDevBadge]: https://travis-ci.org/lz4/lz4.svg?branch=dev "Continuous Integration test suite"
[travisLink]: https://travis-ci.org/lz4/lz4 [travisLink]: https://travis-ci.org/lz4/lz4
[AppveyorMasterBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=master&svg=true "Windows test suite"
[AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=dev&svg=true "Windows test suite" [AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/github/lz4/lz4?branch=dev&svg=true "Windows test suite"
[AppveyorLink]: https://ci.appveyor.com/project/YannCollet/lz4-1lndh [AppveyorLink]: https://ci.appveyor.com/project/YannCollet/lz4-1lndh
[coverBadge]: https://scan.coverity.com/projects/4735/badge.svg "Static code analysis of Master branch"
[coverlink]: https://scan.coverity.com/projects/4735
> **Branch Policy:**
> - The "master" branch is considered stable, at all times.
> - The "dev" branch is the one where all contributions must be merged
before being promoted to master.
> + If you plan to propose a patch, please commit into the "dev" branch,
or its own feature branch.
Direct commit to "master" are not permitted.
Benchmarks Benchmarks
------------------------- -------------------------

4
contrib/debian/copyright
View File

@ -4,6 +4,6 @@ Upstream-Contact: Yann Collet <Cyan4973@github.com>
Source: https://github.com/lz4/lz4 Source: https://github.com/lz4/lz4
Files: * Files: *
Copyright: (C) 2011+ Yann Collet Copyright: (C) 2011-2020 Yann Collet
License: GPL-2+ License: GPL-2+
The full text of license: https://github.com/Cyan4973/lz4/blob/master/lib/LICENSE The full text of license: https://github.com/lz4/lz4/blob/dev/lib/LICENSE

4
doc/lz4_Frame_format.md
View File

@ -263,7 +263,7 @@ This field uses 4-bytes, format is little-endian.
If the highest bit is set (`1`), the block is uncompressed. If the highest bit is set (`1`), the block is uncompressed.
If the highest bit is not set (`0`), the block is LZ4-compressed, If the highest bit is not set (`0`), the block is LZ4-compressed,
using the [LZ4 block format specification](https://github.com/lz4/lz4/blob/master/doc/lz4_Block_format.md). using the [LZ4 block format specification](https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md).
All other bits give the size, in bytes, of the data section. All other bits give the size, in bytes, of the data section.
The size does not include the block checksum if present. The size does not include the block checksum if present.
@ -284,7 +284,7 @@ __Data__
Where the actual data to decode stands. Where the actual data to decode stands.
It might be compressed or not, depending on previous field indications. It might be compressed or not, depending on previous field indications.
When compressed, the data must respect the [LZ4 block format specification](https://github.com/lz4/lz4/blob/master/doc/lz4_Block_format.md). When compressed, the data must respect the [LZ4 block format specification](https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md).
Note that a block is not necessarily full. Note that a block is not necessarily full.
Uncompressed size of data can be any size __up to__ _Block_Maximum_Size_, Uncompressed size of data can be any size __up to__ _Block_Maximum_Size_,

2
examples/Makefile
View File

@ -19,7 +19,7 @@
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# #
# You can contact the author at : # You can contact the author at :
# - LZ4 source repository : https://github.com/Cyan4973/lz4 # - LZ4 source repository : https://github.com/lz4/lz4
# - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c # - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c
# ########################################################################## # ##########################################################################
# This makefile compile and test # This makefile compile and test

2
lib/Makefile
View File

@ -28,7 +28,7 @@
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# #
# You can contact the author at : # You can contact the author at :
# - LZ4 source repository : https://github.com/Cyan4973/lz4 # - LZ4 source repository : https://github.com/lz4/lz4
# - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c # - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c
# ################################################################ # ################################################################

2
programs/Makefile
View File

@ -22,7 +22,7 @@
# #
# You can contact the author at : # You can contact the author at :
# - LZ4 homepage : http://www.lz4.org # - LZ4 homepage : http://www.lz4.org
# - LZ4 source repository : https://github.com/Cyan4973/lz4 # - LZ4 source repository : https://github.com/lz4/lz4
# ########################################################################## # ##########################################################################
# lz4 : Command Line Utility, supporting gzip-like arguments # lz4 : Command Line Utility, supporting gzip-like arguments
# lz4c : CLU, supporting also legacy lz4demo arguments # lz4c : CLU, supporting also legacy lz4demo arguments