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/fsoverlay.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'hst/fsoverlay.go') 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"` } -- cgit v1.3.1