From 8a91234cb4d8cbf6e1d5b909bc11f630d78a93e5 Mon Sep 17 00:00:00 2001 From: Ophestra Date: Sun, 12 Oct 2025 05:03:14 +0900 Subject: hst: reword and improve doc comments This corrects minor mistakes in doc comments and adds them for undocumented constants. Signed-off-by: Ophestra --- hst/fs.go | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'hst/fs.go') diff --git a/hst/fs.go b/hst/fs.go index 07ed6b4a..926d6233 100644 --- a/hst/fs.go +++ b/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"` } -- cgit v1.3.1