bundles: Write a comment about bundle states

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/src/bundles.rs b/src/bundles.rs
index 23da1bd40b407069f39675d66e5266ebb68c54d1..4c95ebde4f205deb141987e69df1eb882d4d37d1 100644 (file)
--- a/src/bundles.rs
+++ b/src/bundles.rs
@@ -71,6 +71,18 @@ pub enum LoadError {
 }
 display_as_debug!{LoadError}
 
+// Bundle states:
+//
+//              GameState   Instance      Note       main file    .d
+//              pieces &c   libs, specs
+//
+//  ABSENT        unused     absent       None        absent      absent
+//  NEARLY-ABSENT unused     absent       Uploading   absent      absent
+//  WRECKAGE      unused     absent       Uploading   maybe .tmp  wreckage
+//  BROKEN        unused     absent       Loaded      .zip        populated
+//  UNUSED        unused     available    Loaded      .zip        populated
+//  USED          used       available    Loaded      .zip        populated
+
 //---------- private definitions ----------
 
 pub type ZipArchive = zipfile::read::ZipArchive<BufReader<File>>;