Merge branch '6997-keepstore-mem' refs #6997

[arvados.git] / services / keepstore / volume_test.go

diff --git a/services/keepstore/volume_test.go b/services/keepstore/volume_test.go
index d660017aaa253a59cf1b4eb32a215f37f3ff64c3..c5a7491b3d542951983ad67e7eec29baa972f966 100644 (file)
--- a/services/keepstore/volume_test.go
+++ b/services/keepstore/volume_test.go
@@ -22,10 +22,13 @@ type MockVolume struct {
        // Readonly volumes return an error for Put, Delete, and
        // Touch.
        Readonly bool
-       // Every operation (except Status) starts by receiving from
-       // Gate. Send one value to unblock one operation; close the
-       // channel to unblock all. By default, it is a closed channel,
-       // so all operations proceed without blocking.
+       // Gate is a "starting gate", allowing test cases to pause
+       // volume operations long enough to inspect state. Every
+       // operation (except Status) starts by receiving from
+       // Gate. Sending one value unblocks one operation; closing the
+       // channel unblocks all operations. By default, Gate is a
+       // closed channel, so all operations proceed without
+       // blocking. See trash_worker_test.go for an example.
        Gate   chan struct{}
        called map[string]int
        mutex  sync.Mutex