summaryrefslogtreecommitdiff
path: root/libpod/lock/lock.go
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2019-01-04 14:15:08 -0500
committerMatthew Heon <matthew.heon@pm.me>2019-01-07 09:45:26 -0500
commiteba89259a5938f047d78b74c5bbbc908f8ff4be8 (patch)
treec5507f5c7a248252a819cdfa765e767c9faf531e /libpod/lock/lock.go
parenta219431a317a2b6d9647ce81b7c845345e51b7da (diff)
downloadpodman-eba89259a5938f047d78b74c5bbbc908f8ff4be8.tar.gz
podman-eba89259a5938f047d78b74c5bbbc908f8ff4be8.tar.bz2
podman-eba89259a5938f047d78b74c5bbbc908f8ff4be8.zip
Address lingering review comments from SHM locking PR
Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'libpod/lock/lock.go')
-rw-r--r--libpod/lock/lock.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/libpod/lock/lock.go b/libpod/lock/lock.go
index 73c1fdcf7..1f94171fe 100644
--- a/libpod/lock/lock.go
+++ b/libpod/lock/lock.go
@@ -43,6 +43,9 @@ type Locker interface {
// encounters a fatal error.
// All errors must be handled internally, as they are not returned. For
// the most part, panicking should be appropriate.
+ // Some lock implementations may require that Lock() and Unlock() occur
+ // within the same goroutine (SHM locking, for example). The usual Go
+ // Lock()/defer Unlock() pattern will still work fine in these cases.
Lock()
// Unlock unlocks the lock.
// All errors must be handled internally, as they are not returned. For