Update documentation for crc32c, cpu

This commit is contained in:
Harshavardhana 2014-12-13 01:39:14 -08:00
parent 643a293d94
commit 71c774f99b
9 changed files with 77 additions and 1 deletions

View File

@ -0,0 +1,11 @@
all: build test
.PHONY: all
build:
@godep go build
test: build
@godep go test -race -coverprofile=cover.out
clean:
@rm -v cover.out

View File

@ -0,0 +1,10 @@
// Package crc32c provides wrapper around Intel's fast CRC32C with PCLMULQDQ instructions.
// The white papers on CRC32C calculations with PCLMULQDQ instruction can be downloaded from:
//
// http://www.intel.com/content/dam/www/public/us/en/documents/white-papers/crc-iscsi-polynomial-crc32-instruction-paper.pdf
// http://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-crc-computation-paper.pdf
//
// Example
//
// crc32c.Crc32c(value) - value can be any []byte, return value is uint32 value
package crc32c

View File

@ -0,0 +1,11 @@
all: build test
.PHONY: all
build:
@godep go build
test: build
@godep go test -race -coverprofile=cover.out
clean:
@rm -v cover.out

11
pkgs/cpu/Makefile Normal file
View File

@ -0,0 +1,11 @@
all: build test
.PHONY: all
build:
@godep go build
test: build
@godep go test -race -coverprofile=cover.out
clean:
@rm -v cover.out

11
pkgs/cpu/doc.go Normal file
View File

@ -0,0 +1,11 @@
// Package cpu provides wrapper around assembly functions for checking processor
// instruction capabilities for SSE4.1, AVX, AVX2 support
//
// Example
//
// ``cpu.HasSSE41()`` returns true for SSE4.1 instruction support, false otherwise
//
// ``cpu.HasAVX()`` returns true for AVX instruction support, false otherwise
//
// ``cpu.HasAVX2()`` returns true for AVX2 instruction support, false otherwise
package cpu

View File

@ -32,7 +32,6 @@
//
// Example
//
//
// Creating and using an encoder
// var bytes []byte
// params := erasure.ParseEncoderParams(10, 5, erasure.CAUCHY)

View File

@ -0,0 +1,11 @@
all: build test
.PHONY: all
build:
@godep go build
test: build
@godep go test -race -coverprofile=cover.out
clean:
@rm -v cover.out

View File

@ -0,0 +1,11 @@
all: build test
.PHONY: all
build:
@godep go build
test: build
@godep go test -race -coverprofile=cover.out
clean:
@rm -v cover.out

View File

@ -4,6 +4,7 @@ import "io"
type ObjectStorage interface {
List() ([]ObjectDescription, error)
// ListBucket(bucketName string) ([]ObjectDescription, error)
Get(path string) (io.Reader, error)
Put(path string, object io.Reader) error
}