diff options
| author | Ophestra <cat@gensokyo.uk> | 2025-10-12 05:03:14 +0900 |
|---|---|---|
| committer | Ophestra <cat@gensokyo.uk> | 2025-10-12 05:03:14 +0900 |
| commit | 8a91234cb4d8cbf6e1d5b909bc11f630d78a93e5 (patch) | |
| tree | 2a8997564266ff2c2815d67ba5261fbd9e29ed05 /hst/fsoverlay.go | |
| parent | db7051a36814a5c9e02e22c2e8d1df42c5f4b8f0 (diff) | |
hst: reword and improve doc comments
This corrects minor mistakes in doc comments and adds them for undocumented constants.
Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'hst/fsoverlay.go')
| -rw-r--r-- | hst/fsoverlay.go | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/hst/fsoverlay.go b/hst/fsoverlay.go index 689970df..de4e14dd 100644 --- a/hst/fsoverlay.go +++ b/hst/fsoverlay.go @@ -14,14 +14,14 @@ const FilesystemOverlay = "overlay" // FSOverlay represents an overlay mount point. type FSOverlay struct { - // mount point in container + // Pathname in the container mount namespace. Target *check.Absolute `json:"dst"` - // any filesystem, does not need to be on a writable filesystem, must not be nil + // Any filesystem, does not need to be on a writable filesystem, must not be nil. Lower []*check.Absolute `json:"lower"` - // the upperdir is normally on a writable filesystem, leave as nil to mount Lower readonly + // The upperdir is normally on a writable filesystem, leave as nil to mount Lower readonly. Upper *check.Absolute `json:"upper,omitempty"` - // the workdir needs to be an empty directory on the same filesystem as Upper, must not be nil if Upper is populated + // The workdir needs to be an empty directory on the same filesystem as Upper, must not be nil if Upper is populated. Work *check.Absolute `json:"work,omitempty"` } |