user/userns: add godoc for package

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
moby · Jul 22, 2024 · 724dd93 · 724dd93
1 parent 839ee3a
commit 724dd93
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/user/userns/userns.go b/user/userns/userns.go
@@ -1,3 +1,11 @@
+// Package userns provides utilities to detect whether we are currently running
+// in a Linux user namespace.
+//
+// This code was migrated from [libcontainer/runc], which based its implementation
+// on code from [lcx/incus].
+//
+// [libcontainer/runc]: https://github.com/opencontainers/runc/blob/3778ae603c706494fd1e2c2faf83b406e38d687d/libcontainer/userns/userns_linux.go#L12-L49
+// [lcx/incus]: https://github.com/lxc/incus/blob/e45085dd42f826b3c8c3228e9733c0b6f998eafe/shared/util.go#L678-L700
 package userns
 
 // RunningInUserNS detects whether we are currently running in a Linux

diff --git a/user/userns/userns_linux.go b/user/userns/userns_linux.go
@@ -11,7 +11,11 @@ var inUserNS = sync.OnceValue(runningInUserNS)
 
 // runningInUserNS detects whether we are currently running in a user namespace.
 //
-// Originally copied from https://github.com/lxc/incus/blob/e45085dd42f826b3c8c3228e9733c0b6f998eafe/shared/util.go#L678-L700.
+// This code was migrated from [libcontainer/runc] and based on an implementation
+// from [lcx/incus].
+//
+// [libcontainer/runc]: https://github.com/opencontainers/runc/blob/3778ae603c706494fd1e2c2faf83b406e38d687d/libcontainer/userns/userns_linux.go#L12-L49
+// [lcx/incus]: https://github.com/lxc/incus/blob/e45085dd42f826b3c8c3228e9733c0b6f998eafe/shared/util.go#L678-L700
 func runningInUserNS() bool {
 	file, err := os.Open("/proc/self/uid_map")
 	if err != nil {