From cd9b534d6b1d432d3c997ccc5b14f630afb9dda6 Mon Sep 17 00:00:00 2001 From: Ophestra Date: Sat, 28 Feb 2026 20:18:30 +0900 Subject: container: improve documentation This change removes inconsistencies collected over time in this package. Signed-off-by: Ophestra --- container/initbind.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'container/initbind.go') 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 -- cgit v1.3.1