summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2022-04-05 23:26:57 +0700
committerShulhan <ms@kilabit.info>2022-04-06 00:12:43 +0700
commitf4ab4581eb2e7811db9e416d0a8d6d16c4339dee (patch)
tree07a8fc449ad12ab27c3a8025cf81254d70d1ec0c
parentb92e5b78fc43c116c094853f89ab07f85b19f631 (diff)
downloadpakakeh.go-f4ab4581eb2e7811db9e416d0a8d6d16c4339dee.tar.xz
lib/memfs: update comment on the struct Options and its fields
-rw-r--r--lib/memfs/options.go14
1 files changed, 9 insertions, 5 deletions
diff --git a/lib/memfs/options.go b/lib/memfs/options.go
index f85bbf8c..407ecb63 100644
--- a/lib/memfs/options.go
+++ b/lib/memfs/options.go
@@ -8,16 +8,20 @@ const (
defaultMaxFileSize = 1024 * 1024 * 5
)
+// Options to create and initialize the MemFS.
type Options struct {
- // EmbedOptions for GoEmbed.
+ // Embed options for GoEmbed method.
Embed EmbedOptions
- // Root contains path to directory where its contents will be mapped
- // to memory.
+ // Root define the path to directory where its contents will be mapped
+ // to memory or to be embedded as Go source code using GoEmbed.
Root string
- // The includes and excludes pattern applied to path of file in file
- // system.
+ // The includes and excludes pattern applied relative to the system
+ // path.
+ // The Excludes patterns will be applied first before the Includes.
+ // If the path is not excluded and Includes is empty, it will be
+ // assumed as included.
Includes []string
Excludes []string