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:
11
hst/fs.go
11
hst/fs.go
@@ -47,17 +47,16 @@ type Ops interface {
|
||||
Etc(host *check.Absolute, prefix string) Ops
|
||||
}
|
||||
|
||||
// ApplyState holds the address of [container.Ops] and any relevant application state.
|
||||
// ApplyState holds the address of [Ops] and any relevant application state.
|
||||
type ApplyState struct {
|
||||
// AutoEtcPrefix is the prefix for [container.AutoEtcOp].
|
||||
// AutoEtcPrefix is the prefix for [FSBind] in autoetc [FSBind.Special] condition.
|
||||
AutoEtcPrefix string
|
||||
|
||||
Ops
|
||||
}
|
||||
|
||||
var (
|
||||
ErrFSNull = errors.New("unexpected null in mount point")
|
||||
)
|
||||
// ErrFSNull is returned by [json] on encountering a null [FilesystemConfig] value.
|
||||
var ErrFSNull = errors.New("unexpected null in mount point")
|
||||
|
||||
// FSTypeError is returned when [ContainerConfig.Filesystem] contains an entry with invalid type.
|
||||
type FSTypeError string
|
||||
@@ -90,7 +89,7 @@ func (f *FilesystemConfigJSON) Valid() bool {
|
||||
return f != nil && f.FilesystemConfig != nil && f.FilesystemConfig.Valid()
|
||||
}
|
||||
|
||||
// fsType holds the string representation of a [FilesystemConfig]'s concrete type.
|
||||
// fsType holds the string representation of the concrete type of [FilesystemConfig].
|
||||
type fsType struct {
|
||||
Type string `json:"type"`
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user