From mboxrd@z Thu Jan 1 00:00:00 1970 X-GM-THRID: 7012879449257410560 X-Received: by 2002:a17:907:118d:: with SMTP id uz13mr6000382ejb.334.1637313304545; Fri, 19 Nov 2021 01:15:04 -0800 (PST) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a17:906:4795:: with SMTP id cw21ls1084125ejc.1.gmail; Fri, 19 Nov 2021 01:15:03 -0800 (PST) X-Google-Smtp-Source: ABdhPJwZIWnqgh/pVt7JUgc87sO4pjHA1d6Fv+TVG2FHOlmBd4jps+X4F1xTuxoNlF8kY+Zexa9J X-Received: by 2002:a17:906:398:: with SMTP id b24mr5826785eja.49.1637313303452; Fri, 19 Nov 2021 01:15:03 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1637313303; cv=none; d=google.com; s=arc-20160816; b=W/9kX16mT5TZxJfjhaxy7/NscH4LFdZoRhMtjc2G1HSNcHVTmtYoGzeJNvRE1J1n07 pabSBKVLoTo9wAFqvRuBPZN9Czj97rKWTL6Ck231pLckOK0KYI1TXSFS0oEkKRPk0FNf OHFM9shRsBZxBX7W7AHD7qdlrePv8EHOKiWjKP9dGwW9KDmF/k98atQcVizC0yKS6AuQ v9DY5YyUN8wnQ+5l6u+UkHLk0q/D5/tncE6yx2gy+iCKeSRys7uDyZwywdcWtsA9mOaB 8dtOvrbL4rtjRG//5Ug9JLvpKxk1eDVfGn8UiIeF/WHCgHKX2p8drepqvIVBvWc3eind hP1g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from; bh=XvjIwcL1+oV3aHzkPU2ZS8V56wXeepNbkG/xNo75w6M=; b=w6otRDZkZGI3Be3GNYPQDyNGV86dnjjSfPyiWF0ZkI4hXvSDyVI7fz5SjE96+ZCpck VZ+03Z4z1oqdzl823FRbyH2ntcpIl5DX5XdjfCwcGq5efU2gWV4kwr7FEQHMM+xCfU0K oiFcLY7vosEJSLpisHzG8JckhD9nfLekzXjceWaDBlrur4bHQOtIz1Pm0L78wMUhA2NH ViSxG/q2xXCcdVPBDpKn6MNEXqWINQTPnHRXffr6caJW7HqMNldr5Zc6UK1Jfwl7yAOa bDjqoKTJjDc9l9aIfo92qpygSYoDE3RazvlbC1UFr8IL5e3r4ucpEKsp7HPFmTtC9Kov JKhw== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of ubely@ilbers.de designates 85.214.156.166 as permitted sender) smtp.mailfrom=ubely@ilbers.de Return-Path: Received: from shymkent.ilbers.de (shymkent.ilbers.de. [85.214.156.166]) by gmr-mx.google.com with ESMTPS id bi21si166374edb.0.2021.11.19.01.15.03 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 19 Nov 2021 01:15:03 -0800 (PST) Received-SPF: pass (google.com: domain of ubely@ilbers.de designates 85.214.156.166 as permitted sender) client-ip=85.214.156.166; Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of ubely@ilbers.de designates 85.214.156.166 as permitted sender) smtp.mailfrom=ubely@ilbers.de Received: from baighyz.m.ilbers.de (host-80-81-17-52.static.customer.m-online.net [80.81.17.52]) (authenticated bits=0) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8) with ESMTPSA id 1AJ9F0us020418 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 19 Nov 2021 10:15:02 +0100 From: Uladzimir Bely To: isar-users@googlegroups.com Subject: [PATCH v3 5/6] doc: Update docs to fit new IMAGE_TYPE meaning Date: Fri, 19 Nov 2021 10:14:59 +0100 Message-Id: <20211119091500.12341-6-ubely@ilbers.de> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20211119091500.12341-1-ubely@ilbers.de> References: <20211119091500.12341-1-ubely@ilbers.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.0 required=5.0 tests=ALL_TRUSTED autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shymkent.ilbers.de X-TUID: 2h26SxM2dDwf While now IMAGE_TYPE allows to specify several image types, separated by space, this needs to be mentioned in manuals. Signed-off-by: Uladzimir Bely --- doc/user_manual.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/doc/user_manual.md b/doc/user_manual.md index 535d456a..f8f58a5c 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -210,7 +210,10 @@ tmp/deploy/images/rpi/isar-image-base.rpi-sdimg ### Generate full disk image -A bootable disk image is generated if you set IMAGE_TYPE to 'wic-img'. Behind the scenes a tool called `wic` is used to assemble the images. It is controlled by a `.wks` file which you can choose with changing WKS_FILE. Some examples in the tree use that feature already. +A bootable disk image is generated if `wic-img` is listed in IMAGE_TYPE. +Behind the scenes a tool called `wic` is used to assemble the images. +It is controlled by a `.wks` file which you can choose with changing WKS_FILE. +Some examples in the tree use that feature already. ``` # Generate an image for the `i386` target architecture $ bitbake mc:qemui386-buster:isar-image-base @@ -246,7 +249,7 @@ https://github.com/intel/bmap-tools ### Generate container image with root filesystem -A runnable container image is generated if you set IMAGE_TYPE to +A runnable container image is generated if IMAGE_TYPE variable includes 'container-img'. Getting a container image can be the main purpose of an Isar configuration, but not only. @@ -457,6 +460,14 @@ Isar can generate various images types for specific machine. The type of the ima - `ubi-img` - A image for use on mtd nand partitions employing UBI - `vm-img` - A image for use on VirtualBox or VMware +There are several image types can be listed in `IMAGE_TYPE` divided by space. + +Instead of setting multiple image types in one target, user can also use +[multiconfig](#building-target-images-for-multiple-configurations) feature and specify +different image types in different multiconfigs (use qemuamd64-buster-cpiogz.conf +and qemuamd64-buster-tgz.conf as examples). The only requirement is that image types +from different multiconfigs for the same machine/distros should not overlap. + --- ## Add a New Distro @@ -508,7 +519,7 @@ Every machine is described in its configuration file. The file defines the follo - `KERNEL_IMAGE` - The name of kernel binary that it installed to `/boot` folder in target filesystem. This variable is used by Isar to extract the kernel binary and put it into the deploy folder. This makes sense for embedded devices, where kernel and root filesystem are written to different flash partitions. This variable is optional. - `INITRD_IMAGE` - The name of `ramdisk` binary. The meaning of this variable is similar to `KERNEL_IMAGE`. This variable is optional. - `MACHINE_SERIAL` - The name of serial device that will be used for console output. - - `IMAGE_TYPE` - The type of images to be generated for this machine. + - `IMAGE_TYPE` - The types of images to be generated for this machine. Below is an example of machine configuration file for `Raspberry Pi` board: ``` -- 2.20.1