Skip to content

Commit

Permalink
improve readability
Browse files Browse the repository at this point in the history
  • Loading branch information
nkraetzschmar committed Sep 16, 2024
1 parent 90ce125 commit 65af23d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ The `image` and `image.<ext>` scripts are used to directly create an image given
They get a path to the rootfs tar as `argv[1]` and a path where the target image should be written as `argv[2]`.
The `image` script outputs a `.raw` artifact, the `image.<ext>` script does the same but for `.<ext>` artifacts.

The convert scripts instead convert an image artifact created by an imaging script to another image format. e.g. convert a raw image to a VM manager specific format.
The `convert` scripts instead convert from one image format to another.
They take the image artifact created by an image script and output a different format, e.g. convert a raw image to a VM manager specific format.
Scripts of the form `convert.<ext>` get the raw image as input and produce a `.<ext>` output.
Scripts of the form `convert.<extA>~<extB>` get `.<extB>` as input and produces `.<extA>` as output.
The second form is only useful for advanced use cases, if you are not aware of one, you'll probably never need it!

0 comments on commit 65af23d

Please sign in to comment.