summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2020-11-15 01:31:09 -0800
committerYann Collet <cyan@fb.com>2020-11-15 01:31:09 -0800
commit0760724577e7c62cfdc1de6ecae400ab653bb2bf (patch)
treecfe5c49ca9d600b94c9d763d07969d2dc660a1b6
parent0bd7dafc93bae758e86260a63a3f1efb4eac1d82 (diff)
downloadlz4-0760724577e7c62cfdc1de6ecae400ab653bb2bf.tar.gz
lz4-0760724577e7c62cfdc1de6ecae400ab653bb2bf.tar.bz2
lz4-0760724577e7c62cfdc1de6ecae400ab653bb2bf.zip
update doc
-rw-r--r--README.md14
-rw-r--r--contrib/debian/copyright4
-rw-r--r--doc/lz4_Frame_format.md4
-rw-r--r--examples/Makefile2
-rw-r--r--lib/Makefile2
-rw-r--r--programs/Makefile2
6 files changed, 8 insertions, 20 deletions
diff --git a/README.md b/README.md
index 451238b..bdb028c 100644
--- a/README.md
+++ b/README.md
@@ -26,25 +26,13 @@ LZ4 library is provided as open-source software using BSD 2-Clause license.
|Branch |Status |
|------------|---------|
-|master | [![Build Status][travisMasterBadge]][travisLink] [![Build status][AppveyorMasterBadge]][AppveyorLink] [![coverity][coverBadge]][coverlink] |
|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"
[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"
[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
-------------------------
diff --git a/contrib/debian/copyright b/contrib/debian/copyright
index 18a7f48..0914768 100644
--- a/contrib/debian/copyright
+++ b/contrib/debian/copyright
@@ -4,6 +4,6 @@ Upstream-Contact: Yann Collet <Cyan4973@github.com>
Source: https://github.com/lz4/lz4
Files: *
-Copyright: (C) 2011+ Yann Collet
+Copyright: (C) 2011-2020 Yann Collet
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
diff --git a/doc/lz4_Frame_format.md b/doc/lz4_Frame_format.md
index e7cbdbf..7e08841 100644
--- a/doc/lz4_Frame_format.md
+++ b/doc/lz4_Frame_format.md
@@ -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 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.
The size does not include the block checksum if present.
@@ -284,7 +284,7 @@ __Data__
Where the actual data to decode stands.
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.
Uncompressed size of data can be any size __up to__ _Block_Maximum_Size_,
diff --git a/examples/Makefile b/examples/Makefile
index 6a34b33..3ec3e21 100644
--- a/examples/Makefile
+++ b/examples/Makefile
@@ -19,7 +19,7 @@
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# 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
# ##########################################################################
# This makefile compile and test
diff --git a/lib/Makefile b/lib/Makefile
index 8f21d3d..c12949b 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -28,7 +28,7 @@
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# 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
# ################################################################
diff --git a/programs/Makefile b/programs/Makefile
index 4256ae8..c1053f6 100644
--- a/programs/Makefile
+++ b/programs/Makefile
@@ -22,7 +22,7 @@
#
# You can contact the author at :
# - 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
# lz4c : CLU, supporting also legacy lz4demo arguments