Document TempDir parameter

peterbourgon · Aug 14, 2017 · 40ecb11 · 40ecb11
1 parent 6226bdb
commit 40ecb11
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/diskv.go b/diskv.go
@@ -46,7 +46,12 @@ type Options struct {
 	CacheSizeMax uint64 // bytes
 	PathPerm     os.FileMode
 	FilePerm     os.FileMode
-	TempDir      string
+	// If TempDir is set, it will enable filesystem atomic writes by
+	// writing temporary files to that location before being moved
+	// to BasePath.
+	// Note that TempDir MUST be on the same device/partition as
+	// BasePath.
+	TempDir string
 
 	Index     Index
 	IndexLess LessFunction