docs: clarify archive repo type

Today `archive-z2` is still used as the default string to indicate
a `archive` type repository. Make clear that this is the way it is
intended. Otherwise users might think they use an no longer supported
OSTree repository since the mode string is still `archive-z2`.

Signed-off-by: Stefan Agner <stefan.agner@toradex.com>

diff --git a/docs/manual/formats.md b/docs/manual/formats.md
index 1a669bb1b7b5cef0d6f0ea87f786f7811ef5fd00..884b1b5ef3821f2f50309b8f9fc0988c7ddf37bb 100644 (file)
--- a/docs/manual/formats.md
+++ b/docs/manual/formats.md
@@ -22,8 +22,9 @@ where file/content objects are checksummed and managed individually.
 
 The `archive` format simply gzip-compresses each content object.
 Metadata objects are stored uncompressed.  This means that it's easy
-to serve via static HTTP.  Note: this format used to be called `archive-z2`
-for historical reasons.
+to serve via static HTTP.  Note: the repo config file still uses the
+historical term `archive-z2` as mode. But this essentially indicates
+the modern `archive` format.
 
 When you commit new content, you will see new `.filez` files appearing
 in `objects/`.