From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 4 May 2022 23:03:59 +0000 (+0100)
Subject: docs: Make room for format version in doc of bundle metadata
X-Git-Tag: otter-1.1.0~264
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=5c24506d45d31376602794963d606dfdb6fd31f9;p=otter.git

docs: Make room for format version in doc of bundle metadata

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

diff --git a/docs/bundles.rst b/docs/bundles.rst
index 42ce49e9..5ae65176 100644
--- a/docs/bundles.rst
+++ b/docs/bundles.rst
@@ -70,9 +70,13 @@ must refer to it in lowercase.
 ``otter.toml`` bundle top-level metadata
 ----------------------------------------
 
-The top-level ``otter.toml`` contains a single entry ``title``, which
-should be a string.  This is useful because the zipfile's name is not
-stored in the server.
+The top-level ``otter.toml`` contains the following keys:
+
+ * ``title`` identifying the bundle.  This is useful because the
+   zipfile's name is not stored in the server.
+   [string, mandatory]
+
+Newer versions of Otter may assign meanings to other keys.
 
 Bundle management
 -----------------