7121: Add comment about why buffers must be returned.

diff --git a/services/keepstore/volume.go b/services/keepstore/volume.go
index d17af446a6b2674f9e86330ace0fea457d023e2a..bda7d8763dd3a59d7d52cceaed743e6a9c6278e3 100644 (file)
--- a/services/keepstore/volume.go
+++ b/services/keepstore/volume.go
@@ -13,7 +13,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.
+       // finished with it. (Otherwise, the buffer pool will be
+       // depleted and eventually -- when all available buffers are
+       // used and not returned -- operations will reach deadlock.)
        Get(loc string) ([]byte, error)
        // Confirm Get() would return a buffer with exactly the same
        // content as buf. If so, return nil. If not, return