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>
This commit is contained in:
Stefan Agner 2020-04-24 13:02:05 +02:00
parent 7a95929867
commit b7662aaf33
1 changed files with 3 additions and 2 deletions

View File

@ -22,8 +22,9 @@ where file/content objects are checksummed and managed individually.
The `archive` format simply gzip-compresses each content object. The `archive` format simply gzip-compresses each content object.
Metadata objects are stored uncompressed. This means that it's easy 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` to serve via static HTTP. Note: the repo config file still uses the
for historical reasons. 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 When you commit new content, you will see new `.filez` files appearing
in `objects/`. in `objects/`.