summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefan Agner <stefan.agner@toradex.com>2020-04-24 13:02:05 +0200
committerStefan Agner <stefan.agner@toradex.com>2020-04-24 13:04:18 +0200
commitb7662aaf3345f17e234c2ba868b526a3c1baad4d (patch)
treec54a5aa3d29c38e5b52c480cf14f27e3685bdbf0 /docs
parent7a9592986708446cceea0d72b55f2d3219d475aa (diff)
downloadostree-b7662aaf3345f17e234c2ba868b526a3c1baad4d.tar.gz
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>
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/formats.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/manual/formats.md b/docs/manual/formats.md
index 1a669bb1..884b1b5e 100644
--- 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/`.