diff --git a/docs/features.md b/docs/features.md index e511c9f..87c57b7 100644 --- a/docs/features.md +++ b/docs/features.md @@ -111,7 +111,8 @@ The `image` and `image.` 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.` script does the same but for `.` 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.` get the raw image as input and produce a `.` output. Scripts of the form `convert.~` get `.` as input and produces `.` 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!