aboutsummaryrefslogtreecommitdiffhomepage
path: root/container/initbind.go
diff options
context:
space:
mode:
authorOphestra <cat@gensokyo.uk>2026-02-28 20:18:30 +0900
committerOphestra <cat@gensokyo.uk>2026-02-28 20:18:30 +0900
commitcd9b534d6b1d432d3c997ccc5b14f630afb9dda6 (patch)
treefcf2e26356d614bb081e94285a1a8eb19cb8283c /container/initbind.go
parent84e6922f3073ec09756df6075a801529ecd202f6 (diff)
container: improve documentation
This change removes inconsistencies collected over time in this package. Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'container/initbind.go')
-rw-r--r--container/initbind.go8
1 files changed, 5 insertions, 3 deletions
diff --git a/container/initbind.go b/container/initbind.go
index f91d5086..7f240a37 100644
--- a/container/initbind.go
+++ b/container/initbind.go
@@ -12,14 +12,16 @@ import (
func init() { gob.Register(new(BindMountOp)) }
-// Bind appends an [Op] that bind mounts host path [BindMountOp.Source] on container path [BindMountOp.Target].
+// Bind is a helper for appending [BindMountOp] to [Ops].
func (f *Ops) Bind(source, target *check.Absolute, flags int) *Ops {
*f = append(*f, &BindMountOp{nil, source, target, flags})
return f
}
-// BindMountOp bind mounts host path Source on container path Target.
-// Note that Flags uses bits declared in this package and should not be set with constants in [syscall].
+// BindMountOp creates a bind mount from host path Source to container path Target.
+//
+// Note that Flags uses bits declared in the [std] package and should not be set
+// with constants in [syscall].
type BindMountOp struct {
sourceFinal, Source, Target *check.Absolute