Explorar el Código

Document datastore file deletion behavior

Rod Hynes hace 10 años
padre
commit
8c85ac4992
Se han modificado 1 ficheros con 5 adiciones y 0 borrados
  1. 5 0
      psiphon/config.go

+ 5 - 0
psiphon/config.go

@@ -85,6 +85,11 @@ type Config struct {
 	// DataStoreDirectory is the directory in which to store the persistent
 	// database, which contains information such as server entries.
 	// By default, current working directory.
+	//
+	// Warning: If the datastore file, DataStoreDirectory/DATA_STORE_FILENAME,
+	// exists but fails to open for any reason (checksum error, unexpected file
+	// format, etc.) it will be deleted in order to pave a new datastore and
+	// continue running.
 	DataStoreDirectory string
 
 	// DataStoreTempDirectory is the directory in which to store temporary