From 45054c43494069924dbd87d7dda087a591fcaacc Mon Sep 17 00:00:00 2001
From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sat, 15 May 2021 16:19:02 +0100
Subject: [PATCH] bundles: Write a comment about bundle states

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---
 src/bundles.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

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>>;
-- 
2.30.2