Merge pull request #119 from harshavardhana/pr_out_update_documentation_for_crc32c_cpu

pkgs/checksum/crc32c/Makefile

@@ -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

pkgs/checksum/crc32c/doc.go

@@ -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

pkgs/checksum/sha1/Makefile

@@ -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

pkgs/cpu/Makefile

@@ -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

pkgs/cpu/doc.go

@@ -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

pkgs/erasure/doc.go

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

pkgs/storage/appendstorage/Makefile

@@ -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

pkgs/storage/fsstorage/Makefile

@@ -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

pkgs/storage/storage.go

@@ -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
 }