Added comments to describe IBackupFile contract.

2017-11-26 22:02:14 -08:00 · 2017-11-26 22:02:14 -08:00 · 9ce9fd8692
parent 1d3af8f4f0
commit 9ce9fd8692
1 changed files with 2 additions and 0 deletions
--- a/fdbclient/BackupContainer.h
+++ b/fdbclient/BackupContainer.h
@ -27,6 +27,8 @@
 #include <vector>

 // Append-only file interface for writing backup data
+// Once finish() is called the file cannot be further written to.
+// Backup containers should not attempt to use files for which finish was not called or did not complete.
 // TODO: Move the log file and range file format encoding/decoding stuff to this file and behind interfaces.
 class IBackupFile {
 public: