From 6c0cbbb96d3a9a206afdb1b09009c5ac97ea73c1 Mon Sep 17 00:00:00 2001 From: Danielle Lancashire Date: Wed, 19 Feb 2020 11:14:13 +0100 Subject: [PATCH] csi: Add comment to UsageOptions.ToFS() --- client/pluginmanager/csimanager/interface.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/pluginmanager/csimanager/interface.go b/client/pluginmanager/csimanager/interface.go index 413f8ff65..96cc05940 100644 --- a/client/pluginmanager/csimanager/interface.go +++ b/client/pluginmanager/csimanager/interface.go @@ -24,6 +24,10 @@ type UsageOptions struct { AccessMode string } +// ToFS is used by a VolumeManager to construct the path to where a volume +// should be staged/published. It should always return a string that is easy +// enough to manage as a filesystem path segment (e.g avoid starting the string +// with a special character). func (u *UsageOptions) ToFS() string { var sb strings.Builder