From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 15 May 2021 15:19:02 +0000 (+0100)
Subject: bundles: Write a comment about bundle states
X-Git-Tag: otter-0.6.0~290
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=45054c43494069924dbd87d7dda087a591fcaacc;p=otter.git

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 23da1bd4..4c95ebde 100644
--- 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>>;