Merge pull request #34 from dnephin/document-err-mem-not-supported

crosbymichael · web-flow · commit 29da22c6171a · 2017-11-28T14:15:33.000-05:00
Update doc for OOMEventFD
diff --git a/cgroup.go b/cgroup.go
@@ -310,7 +310,8 @@ func (c *cgroup) Thaw() error {
 }
 
 // OOMEventFD returns the memory cgroup's out of memory event fd that triggers
-// when processes inside the cgroup receive an oom event
+// when processes inside the cgroup receive an oom event. Returns
+// ErrMemoryNotSupported if memory cgroups is not supported.
 func (c *cgroup) OOMEventFD() (uintptr, error) {
 	c.mu.Lock()
 	defer c.mu.Unlock()

Original file line number	Diff line number	Diff line change
`@@ -310,7 +310,8 @@ func (c *cgroup) Thaw() error {`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`// OOMEventFD returns the memory cgroup's out of memory event fd that triggers`
`313`		`-// when processes inside the cgroup receive an oom event`
	`313`	`+// when processes inside the cgroup receive an oom event. Returns`
	`314`	`+// ErrMemoryNotSupported if memory cgroups is not supported.`
`314`	`315`	`func (c *cgroup) OOMEventFD() (uintptr, error) {`
`315`	`316`	`c.mu.Lock()`
`316`	`317`	`defer c.mu.Unlock()`