Document FileGetter.Copy with new behaviour

hashicorp · Jan 30, 2019 · 3119040 · 3119040
1 parent e2da0a0
commit 3119040
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/get_file.go b/get_file.go
@@ -10,7 +10,9 @@ import (
 type FileGetter struct {
 	getter
 
-	// Copy, if set to true, will copy data instead of using a symlink
+	// Copy, if set to true, will copy data instead of using a symlink. If
+	// false, attempts to symlink to speed up the operation and to lower the
+	// disk space usage. If the symlink fails, may attempt to copy on windows.
 	Copy bool
 }