github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Improve doc of func NewNetNS

Browse Source 
Signed-off-by: Henry Wang <henwang@amazon.com>
This commit is contained in:
Henry Wang 2023-09-20 17:00:33 +00:00
parent 782ad19f6c
commit dcb2e7447b
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkg/netns/netns_linux.go
View File

@ -177,11 +177,17 @@ type NetNS struct {
} }
// NewNetNS creates a network namespace. // NewNetNS creates a network namespace.
// The name of the network namespace is randomly generated.
// The returned netns is created under baseDir, with its path
// following the pattern "baseDir/<generated-name>".
func NewNetNS(baseDir string) (*NetNS, error) { func NewNetNS(baseDir string) (*NetNS, error) {
return NewNetNSFromPID(baseDir, 0) return NewNetNSFromPID(baseDir, 0)
} }
// NewNetNS returns the netns from pid or a new netns if pid is 0. // NewNetNSFromPID returns the netns from pid or a new netns if pid is 0.
// The name of the network namespace is randomly generated.
// The returned netns is created under baseDir, with its path
// following the pattern "baseDir/<generated-name>".
func NewNetNSFromPID(baseDir string, pid uint32) (*NetNS, error) { func NewNetNSFromPID(baseDir string, pid uint32) (*NetNS, error) {
path, err := newNS(baseDir, pid) path, err := newNS(baseDir, pid)
if err != nil { if err != nil {