hst: reword and improve doc comments
All checks were successful
Test / Create distribution (push) Successful in 34s
Test / Sandbox (push) Successful in 2m9s
Test / Hpkg (push) Successful in 3m58s
Test / Sandbox (race detector) (push) Successful in 4m31s
Test / Hakurei (race detector) (push) Successful in 5m19s
Test / Hakurei (push) Successful in 2m12s
Test / Flake checks (push) Successful in 1m31s
All checks were successful
Test / Create distribution (push) Successful in 34s
Test / Sandbox (push) Successful in 2m9s
Test / Hpkg (push) Successful in 3m58s
Test / Sandbox (race detector) (push) Successful in 4m31s
Test / Hakurei (race detector) (push) Successful in 5m19s
Test / Hakurei (push) Successful in 2m12s
Test / Flake checks (push) Successful in 1m31s
This corrects minor mistakes in doc comments and adds them for undocumented constants. Signed-off-by: Ophestra <cat@gensokyo.uk>
This commit is contained in:
@@ -16,22 +16,23 @@ const FilesystemBind = "bind"
|
||||
|
||||
// FSBind represents a host to container bind mount.
|
||||
type FSBind struct {
|
||||
// mount point in container, same as Source if empty
|
||||
// Pathname in the container mount namespace. Same as Source if nil.
|
||||
Target *check.Absolute `json:"dst,omitempty"`
|
||||
// host filesystem path to make available to the container
|
||||
// Pathname in the init mount namespace. Must not be nil.
|
||||
Source *check.Absolute `json:"src"`
|
||||
// do not mount Target read-only
|
||||
// Do not remount Target read-only.
|
||||
// This has no effect if Source is mounted read-only in the init mount namespace.
|
||||
Write bool `json:"write,omitempty"`
|
||||
// do not disable device files on Target, implies Write
|
||||
// Allow access to devices (special files) on Target, implies Write.
|
||||
Device bool `json:"dev,omitempty"`
|
||||
// create Source as a directory if it does not exist
|
||||
// Create Source as a directory in the init mount namespace if it does not exist.
|
||||
Ensure bool `json:"ensure,omitempty"`
|
||||
// skip this mount point if Source does not exist
|
||||
// Silently skip this mount point if Source does not exist in the init mount namespace.
|
||||
Optional bool `json:"optional,omitempty"`
|
||||
|
||||
// enable special behaviour:
|
||||
// for autoroot, Target must be set to [fhs.AbsRoot];
|
||||
// for autoetc, Target must be set to [fhs.AbsEtc]
|
||||
/* Enable special behaviour:
|
||||
For autoroot: Target must be [fhs.Root].
|
||||
For autoetc: Target must be [fhs.Etc]. */
|
||||
Special bool `json:"special,omitempty"`
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user