diff options
| author | Slack Coder <slackcoder@server.ky> | 2022-03-11 13:08:24 -0500 |
|---|---|---|
| committer | Slack Coder <slackcoder@server.ky> | 2022-03-30 11:34:46 -0500 |
| commit | 29589a24b13fb223b113e94eca2c4fff0e56a4d9 (patch) | |
| tree | e1754d195463439ae2834cd502b170648e47cdb8 /vendor/github.com/xi2/xz/doc.go | |
| download | pkgtools-go-29589a24b13fb223b113e94eca2c4fff0e56a4d9.tar.xz | |
Initial commit
Diffstat (limited to 'vendor/github.com/xi2/xz/doc.go')
| -rw-r--r-- | vendor/github.com/xi2/xz/doc.go | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/vendor/github.com/xi2/xz/doc.go b/vendor/github.com/xi2/xz/doc.go new file mode 100644 index 0000000..f8c62e6 --- /dev/null +++ b/vendor/github.com/xi2/xz/doc.go @@ -0,0 +1,35 @@ +// Package xz implements XZ decompression natively in Go. +// +// Usage +// +// For ease of use, this package is designed to have a similar API to +// compress/gzip. See the examples for further details. +// +// Implementation +// +// This package is a translation from C to Go of XZ Embedded +// (http://tukaani.org/xz/embedded.html) with enhancements made so as +// to implement all mandatory and optional parts of the XZ file format +// specification v1.0.4. It supports all filters and block check +// types, supports multiple streams, and performs index verification +// using SHA-256 as recommended by the specification. +// +// Speed +// +// On the author's Intel Ivybridge i5, decompression speed is about +// half that of the standard XZ Utils (tested with a recent linux +// kernel tarball). +// +// Thanks +// +// Thanks are due to Lasse Collin and Igor Pavlov, the authors of XZ +// Embedded, on whose code package xz is based. It would not exist +// without their decision to allow others to modify and reuse their +// code. +// +// Bug reports +// +// For bug reports relating to this package please contact the author +// through https://github.com/xi2/xz/issues, and not the authors of XZ +// Embedded. +package xz |