Merge branch 'master' into 6588-documentation
[arvados.git] / services / keepstore / volume.go
index 1b5294952820b5cb2f0be2d53c37eb84f2cefed5..64fea34bfe1c32ad9b6b6b33a74c82f8b9f0252f 100644 (file)
@@ -11,6 +11,9 @@ import (
 )
 
 type Volume interface {
+       // Get a block. IFF the returned error is nil, the caller must
+       // put the returned slice back into the buffer pool when it's
+       // finished with it.
        Get(loc string) ([]byte, error)
        Put(loc string, block []byte) error
        Touch(loc string) error