Update readme and re-allow s390x failure.

master
Klaus Post 2020-05-14 14:29:53 +02:00
parent f338110979
commit e8fdfd6630
No known key found for this signature in database
GPG Key ID: BAA2096BE0B8A075
2 changed files with 10 additions and 5 deletions

View File

@ -37,6 +37,7 @@ stages:
jobs:
allow_failures:
- go: 'master'
- arch: s390x
fast_finish: true
include:
- stage: gofmt

View File

@ -2,7 +2,7 @@
[![GoDoc][1]][2] [![Build Status][3]][4]
[1]: https://godoc.org/github.com/klauspost/reedsolomon?status.svg
[2]: https://godoc.org/github.com/klauspost/reedsolomon
[2]: https://pkg.go.dev/github.com/klauspost/reedsolomon?tab=doc
[3]: https://travis-ci.org/klauspost/reedsolomon.svg?branch=master
[4]: https://travis-ci.org/klauspost/reedsolomon
@ -15,7 +15,7 @@ For an introduction on erasure coding, see the post on the [Backblaze blog](http
Package home: https://github.com/klauspost/reedsolomon
Godoc: https://godoc.org/github.com/klauspost/reedsolomon
Godoc: https://pkg.go.dev/github.com/klauspost/reedsolomon?tab=doc
# Installation
To get the package use the standard:
@ -27,9 +27,8 @@ go get -u github.com/klauspost/reedsolomon
## May 2020
Numerous updates:
* Added WithFastOneParityMatrix for faster operation with 1 parity shard.
* ARM64 optimizations, up to 2.5x faster.
* Added [WithFastOneParityMatrix](https://pkg.go.dev/github.com/klauspost/reedsolomon?tab=doc#WithFastOneParityMatrix) for faster operation with 1 parity shard.
* Much better performance when using a limited number of goroutines.
* AVX512 is now using multiple cores.
* Stream processing overhaul, big speedups in most cases.
@ -108,6 +107,11 @@ This encoder will work for all parity sets with this distribution of data and pa
The error will only be set if you specify 0 or negative values in any of the parameters,
or if you specify more than 256 data shards.
If you will primarily be using it with one shard size it is recommended to use
[`WithAutoGoroutines(shardSize)`](https://pkg.go.dev/github.com/klauspost/reedsolomon?tab=doc#WithAutoGoroutines)
as an additional parameter. This will attempt to calculate the optimal number of goroutines to use for the best speed.
It is not required that all shards are this size.
The you send and receive data is a simple slice of byte slices; `[][]byte`.
In the example above, the top slice must have a length of 13.