diff options
| author | Ophestra <cat@gensokyo.uk> | 2026-03-11 19:21:55 +0900 |
|---|---|---|
| committer | Ophestra <cat@gensokyo.uk> | 2026-03-11 19:21:55 +0900 |
| commit | 330a344845aa8653772a9be6c085f4fdb602a028 (patch) | |
| tree | 7ed7f60ad70121be51289cbe9043c003d1940e19 /hst/fsoverlay.go | |
| parent | 48cdf8bf852234ea3dad8dad3d571bb1d9546c32 (diff) | |
hst: improve doc comments
These now read a lot better both in source and on pkgsite.
Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'hst/fsoverlay.go')
| -rw-r--r-- | hst/fsoverlay.go | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/hst/fsoverlay.go b/hst/fsoverlay.go index de4e14dd..72df1deb 100644 --- a/hst/fsoverlay.go +++ b/hst/fsoverlay.go @@ -19,9 +19,11 @@ type FSOverlay struct { // 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"` } |