diff mbox series

[v2,3/3] doc: Update available image types

Message ID 20211028171727.246342-4-amikan@ilbers.de
State Changes Requested
Headers show
Series Update Isar documentation | expand

Commit Message

Anton Mikanovich Oct. 28, 2021, 8:17 a.m. UTC 
Update the list of image types can be used for targets.

Signed-off-by: Anton Mikanovich <amikan@ilbers.de>
---
 doc/user_manual.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 1b00a47..b4dbe85 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -450,10 +450,16 @@  Please refer to `Add a Custom Application` section for more information about wr
 
 Isar can generate various images types for specific machine. The type of the image to be generated may be specified through the `IMAGE_TYPE` variable. Currently, the following image types are provided:
 
- - `ext4` - Raw ext4 filesystem image (default option for `qemuarm` machine).
+ - `ext4-img` - Raw ext4 filesystem image (default option for `qemuarm` machine).
  - `rpi-sdimg` - A complete, partitioned Raspberry Pi SD card image (default option for the `rpi` machine).
  - `wic-img` - A full disk image with user-specified partitions created and populated using the wic tool.
- - `ubi-img` - A image for use on mtd nand partitions employing UBI
+ - `targz-img` - Compressed Tar archive with filesystem.
+ - `fit-img` - Flattened Image Tree filesystem image with user-specified binaries included.
+ - `ubifs-img` - UBIFS filesystem image to be used with ubiupdatevol.
+ - `ubi-img` - An image for use on mtd nand partitions employing UBI.
+ - `ubi-ubifs-img` - An image encapsulates FIT and UBI image types.
+ - `container-img` - Container image specified by `CONTAINER_FORMAT` value.
+ - `cpiogz-img` - An initramfs like filesystem.
  - `vm-img` - A image for use on VirtualBox or VMware
 
 ---
@@ -582,9 +588,13 @@  Isar contains additional image type classes that can be used as reference:
  - `ext4-img`
  - `rpi-sdimg`
  - `targz-img`
+ - `fit-img`
  - `ubifs-img`
  - `ubi-img`
  - `wic-img`
+ - `container-img`
+ - `cpiogz-img`
+ - `vm-img`
 
 ### Imager dependencies and bootloaders