From: Gabe Rosenhouse <grosenhouse@pivotal.io>
Date: Tue, 15 Mar 2016 15:37:00 +0000 (-0700)
Subject: Update docstring on WithNetNS
X-Git-Url: https://git.halfball.org/?a=commitdiff_plain;h=ca978caee7a39cfbfe2b5fdbbfa1942a561d94a2;p=plugins.git

Update docstring on WithNetNS
---

diff --git a/ns/ns.go b/ns/ns.go
index 97c6a1e..4f0814f 100644
--- a/ns/ns.go
+++ b/ns/ns.go
@@ -66,7 +66,8 @@ func WithNetNSPath(nspath string, lockThread bool, f func(*os.File) error) error
 // Changing namespaces must be done on a goroutine that has been
 // locked to an OS thread. If lockThread arg is true, this function
 // locks the goroutine prior to change namespace and unlocks before
-// returning
+// returning.  If the closure returns an error, WithNetNS attempts to
+// restore the original namespace before returning.
 func WithNetNS(ns *os.File, lockThread bool, f func(*os.File) error) error {
 	if lockThread {
 		runtime.LockOSThread()