aboutsummaryrefslogtreecommitdiffhomepage
path: root/hst/fsephemeral.go
diff options
context:
space:
mode:
authorOphestra <cat@gensokyo.uk>2025-10-12 05:03:14 +0900
committerOphestra <cat@gensokyo.uk>2025-10-12 05:03:14 +0900
commit8a91234cb4d8cbf6e1d5b909bc11f630d78a93e5 (patch)
tree2a8997564266ff2c2815d67ba5261fbd9e29ed05 /hst/fsephemeral.go
parentdb7051a36814a5c9e02e22c2e8d1df42c5f4b8f0 (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/fsephemeral.go')
-rw-r--r--hst/fsephemeral.go10
1 files changed, 5 insertions, 5 deletions
diff --git a/hst/fsephemeral.go b/hst/fsephemeral.go
index 631235b5..78c4a55a 100644
--- a/hst/fsephemeral.go
+++ b/hst/fsephemeral.go
@@ -15,13 +15,13 @@ const FilesystemEphemeral = "ephemeral"
// FSEphemeral represents an ephemeral container mount point.
type FSEphemeral struct {
- // mount point in container
- Target *check.Absolute `json:"dst,omitempty"`
- // do not mount filesystem read-only
+ // Pathname in the container mount namespace.
+ Target *check.Absolute `json:"dst"`
+ // Do not mount filesystem read-only.
Write bool `json:"write,omitempty"`
- // upper limit on the size of the filesystem
+ // Upper limit on the size of the filesystem.
Size int `json:"size,omitempty"`
- // initial permission bits of the new filesystem
+ // Initial permission bits of the new filesystem.
Perm os.FileMode `json:"perm,omitempty"`
}