From: Henning Schild <henning.schild@siemens.com>
To: isar-users@googlegroups.com
Cc: Cedric Hombourger <Cedric_Hombourger@mentor.com>,
Andreas Reichel <andreas.reichel.ext@siemens.com>,
Henning Schild <henning.schild@siemens.com>
Subject: [PATCH v2 16/17] docs: Change according to recent patches
Date: Fri, 13 Apr 2018 16:19:05 +0200 [thread overview]
Message-ID: <7a3e04b07c02ad0e26a7ea58c6218d09107d723b.1523628814.git.henning.schild@siemens.com> (raw)
In-Reply-To: <cover.1523628814.git.henning.schild@siemens.com>
In-Reply-To: <cover.1523628814.git.henning.schild@siemens.com>
Update the section on wic to tell people how to build images using it.
Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
doc/technical_overview.md | 7 ++++---
doc/user_manual.md | 25 ++++++++++++-------------
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/doc/technical_overview.md b/doc/technical_overview.md
index 83624a5..ab62de9 100644
--- a/doc/technical_overview.md
+++ b/doc/technical_overview.md
@@ -239,10 +239,11 @@ variable. Task `do_populate` performs the following:
4. Execute dpkg command in chroot for all the copied packages.
-## 3.7 Generate Bootable Image
+## 3.7 Generate an Image
This process contains the following steps:
-1. Task `do_ext4_image`: target filesystem is packed to extfs image.
+1. Task `do_<..>_image`: creates filesystem or disk images
-2. wic tool generates bootable image for dedicated platform.
+ 1.1. `do_ext4_image`: target filesystem is packed to extfs image.
+ 1.2. `do_wic_image`: a bootable disk image gets created for the platform
diff --git a/doc/user_manual.md b/doc/user_manual.md
index 7bd52f4..7bdfc1c 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -190,34 +190,33 @@ Created images are:
../build-2/tmp/deploy/images/isar-image-base-debian-jessie-qemuarm.ext4.img
../build-3/tmp/deploy/images/isar-image-base-debian-stretch-qemuarm.ext4.img
../build-4/tmp/deploy/images/isar-image-base-debian-jessie-qemui386.ext4.img
-../build-5/tmp/deploy/images/isar-image-base-debian-stretch-qemui386.ext4.img
+../build-5/tmp/deploy/images/isar-image-base-debian-stretch-qemui386.wic.img
../build-6/tmp/deploy/images/isar-image-base-debian-jessie-qemuamd64.ext4.img
-../build-7/tmp/deploy/images/isar-image-base-debian-stretch-qemuamd64.ext4.img
+../build-7/tmp/deploy/images/isar-image-base-debian-stretch-qemuamd64.wic.img
../build-8/tmp/deploy/images/isar-image-base.rpi-sdimg
```
-### Generate EFI disk images
+### Generate full disk image
-Once the image artifacts have been built (c.f. previous section), full EFI disk images can be generated using the `wic` utility.
-Currently, only the `i386` and `amd64` target architectures are supported:
+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.
```
- # Generate an EFI image for the `i386` target architecture
- $ wic create -D sdimage-efi -o . -e multiconfig:qemui386-stretch:isar-image-base
- # Similarly, for the `amd64` target architecture
- $ wic create -D sdimage-efi -o . -e multiconfig:qemuamd64-stretch:isar-image-base
+ # Generate an image for the `i386` target architecture
+ $ bitbake multiconfig:qemui386-stretch:isar-image-base
+ # Similarly, for the `amd64` target architecture, in this case EFI
+ $ bitbake multiconfig:qemuamd64-stretch:isar-image-base
```
-In order to run the images with `qemu`, an EFI firmware is required and available at the following address:
+In order to run the EFI images with `qemu`, an EFI firmware is required and available at the following address:
https://github.com/tianocore/edk2/tree/3858b4a1ff09d3243fea8d07bd135478237cb8f7
Note that the `ovmf` package in Debian jessie/stretch/sid contains a pre-compiled firmware, but doesn't seem to be recent
enough to allow images to be testable under `qemu`.
```
-# AMD64 image
-qemu-system-x86_64 -m 256M -nographic -bios edk2/Build/OvmfX64/RELEASE_*/FV/OVMF.fd -hda ./sdimage-*
+# AMD64 image, EFI
+qemu-system-x86_64 -m 256M -nographic -bios edk2/Build/OvmfX64/RELEASE_*/FV/OVMF.fd -hda tmp/deploy/images/isar-image-base-debian-stretch-qemuamd64.wic.img
# i386 image
-qemu-system-i386 -m 256M -nographic -bios edk2/Build/OvmfIa32/RELEASE_*/FV/OVMF.fd -hda ./sdimage-*
+qemu-system-i386 -m 256M -nographic -hda tmp/deploy/images/isar-image-base-debian-stretch-qemui386.wic.img
```
---
--
2.16.1
next prev parent reply other threads:[~2018-04-13 14:19 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-13 14:18 [PATCH v2 00/16] wic integration Henning Schild
2018-04-13 14:18 ` [PATCH v2 01/17] Revert "wic: Make the bootimg-efi plugin generate usable images" Henning Schild
2018-04-13 14:18 ` [PATCH v2 02/17] Revert "wic: Introduce the `WicExecError` exception class" Henning Schild
2018-04-13 14:18 ` [PATCH v2 03/17] Revert "wic: Work around mcopy error" Henning Schild
2018-04-13 14:18 ` [PATCH v2 04/17] Revert "wic: Use sudo instead of pseudo" Henning Schild
2018-04-16 10:44 ` Andreas Reichel
2018-04-16 10:53 ` Andreas Reichel
2018-04-16 10:57 ` Henning Schild
2018-04-13 14:18 ` [PATCH v2 05/17] Revert "wic: Remove sysroot support" Henning Schild
2018-04-13 14:18 ` [PATCH v2 06/17] wic: now truly go for the wic version we claim to have Henning Schild
2018-04-13 14:18 ` [PATCH v2 07/17] Revert "isar-init-build-env: Add /sbin to PATH" Henning Schild
2018-04-13 14:18 ` [PATCH v2 08/17] classes: image: introduce size measuring function, for before do_*_image Henning Schild
2018-04-13 14:18 ` [PATCH v2 09/17] meta/image: Fix broken variables KERNEL_IMAGE and INITRD_IMAGE Henning Schild
2018-04-16 10:45 ` Andreas Reichel
2018-04-13 14:18 ` [PATCH v2 10/17] isar-init-build-env: make ISARROOT available in bitbake Henning Schild
2018-04-13 14:19 ` [PATCH v2 11/17] images: New class wic-img for wic intregration Henning Schild
2018-04-13 14:44 ` Henning Schild
2018-04-16 10:17 ` Claudius Heine
2018-04-16 10:25 ` Henning Schild
2018-04-16 10:31 ` Andreas Reichel
2018-04-13 14:19 ` [PATCH v2 12/17] wic: Add pcibios boot plugins and wks files Henning Schild
2018-04-16 10:52 ` Andreas Reichel
2018-04-16 11:48 ` Henning Schild
2018-04-13 14:19 ` [PATCH v2 13/17] scripts/start_vm: Enable booting of full disk images Henning Schild
2018-04-16 10:33 ` Andreas Reichel
2018-04-16 11:46 ` Henning Schild
2018-04-16 13:24 ` Andreas Reichel
2018-04-13 14:19 ` [PATCH v2 14/17] multiconfig: Switch qemuamd64-stretch to using wic by default Henning Schild
2018-04-16 10:25 ` Claudius Heine
2018-04-16 10:32 ` Henning Schild
2018-04-13 14:19 ` [PATCH v2 15/17] multiconfig: Switch qemui386-stretch " Henning Schild
2018-04-16 10:35 ` Andreas Reichel
2018-04-16 10:43 ` Henning Schild
2018-04-16 10:51 ` Henning Schild
2018-04-16 10:56 ` Claudius Heine
2018-04-13 14:19 ` Henning Schild [this message]
2018-04-13 14:19 ` [PATCH v2 17/17] scripts/vm_smoke_test: double the timeout we wait for qemus Henning Schild
2018-04-16 10:47 ` Andreas Reichel
2018-04-16 11:45 ` Henning Schild
2018-04-25 15:53 ` [PATCH v2 00/16] wic integration Alexander Smirnov
2018-04-26 11:26 ` Henning Schild
2018-05-01 19:23 ` Alexander Smirnov
2018-05-03 16:32 ` Henning Schild
2018-05-03 16:39 ` Alexander Smirnov
2018-05-04 8:16 ` Henning Schild
2018-05-04 8:32 ` Alexander Smirnov
2018-05-04 9:30 ` Henning Schild
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7a3e04b07c02ad0e26a7ea58c6218d09107d723b.1523628814.git.henning.schild@siemens.com \
--to=henning.schild@siemens.com \
--cc=Cedric_Hombourger@mentor.com \
--cc=andreas.reichel.ext@siemens.com \
--cc=isar-users@googlegroups.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox