Skip to content

Commit

Permalink
manpage: Add versioning description to mkcomposefs.1
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Larsson <[email protected]>
  • Loading branch information
alexlarsson committed Jan 29, 2024
1 parent ebd4a41 commit 821a18c
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions man/mkcomposefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,43 @@ will be a mountable composefs image.
: The source is a file in the **composefs-dump(5)** format. If
the specified file is "-", the data is read from stdin.

**\-\-version**
: The base version to use for the image format.

**\-\-max-version**
: If this specifies a version higher than --versions, then the
actual image format version used will be adjusted upwards if that
is benefitial for the image, up to the max version.

# FORMAT VERSIONING

Composefs iamges are binary reproduceable, meaning that for a given
input the result is always the same, giving the same digest of the
image. This is important as the digest is used to validate the image,
even if the image was re-created rather than transferred as
is. However, sometimes the format needs to be changed, such as for
example when a new type of file is introduced or a bug is fixed. This
is handled by introducing a format version.

Specifying the version is done with two options, the base version
(\-\-version) and the max version (\-\-max-version). When building an
image, mkcomposefs tries to keep the image format as low as possible,
but if some particular requested feature is not available with the
base feature, but is accessible in the max version then the version
used will be increased. This allows us to introduce new features and
fix bugs in a later version and migrate to that using max versions,
but still keeping the digests identical for unaffected images.

If you need 100% binary reproducibliliy over time, specify the same
version and a max version each time.

Format version history:

- 0 - Initial version
- 1 - Supports overlay whiteout files in the image (added in 1.0.3)

The default if no version arguments are specified is version 0 and max
version 1.

# SEE ALSO
**composefs-info(1)**, **mount.composefs(1)**, **composefs-dump(5)**
Expand Down

0 comments on commit 821a18c

Please sign in to comment.