From e21faa4a9cc4b29ff8aa094877d14256cfd280ba Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 21 Feb 2018 17:30:12 -0800 Subject: dev-manual: Updated Wic example using existing kickstart file. (From yocto-docs rev: a1f25bd6aae35e4c052e348949bea332b9203c20) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 125 ++++++++++++--------- 1 file changed, 71 insertions(+), 54 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 6df56d8b2c..cf6eb1ffd4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -5268,6 +5268,7 @@ $ wic -h $ wic --help + $ wic help @@ -5277,51 +5278,66 @@ help, list, ls, rm, and write. - You can get help for these commands as follows with - command being one of the - supported commands: + You can get help for all these commands except "help" by + using the following form: $ wic help command + For example, the following command returns help for the + write command: + + $ wic help write + - You can also get detailed help on a number of topics - from the help system. - The output of wic --help - displays a list of available help - topics under a "Help topics" heading. - You can have the help system display the help text for - a given topic by prefacing the topic with - wic help: + Wic supports help for three topics: + overview, + plugins, and + kickstart. + You can get help for any topic using the following form: - $ wic help help_topic + $ wic help topic + + For example, the following returns overview help for Wic: + + $ wic help overview - You can find out more about the images Wic creates using - the existing kickstart files with the following form of - the command: + One additional level of help exists for Wic. + You can get help on individual images through the + list command. + You can use the list command to return the + available Wic images as follows: - $ wic list image help + $ wic list images + mpc8315e-rdb Create SD card image for MPC8315E-RDB + genericx86 Create an EFI disk image for genericx86* + beaglebone-yocto Create SD card image for Beaglebone + edgerouter Create SD card image for Edgerouter + qemux86-directdisk Create a qemu machine 'pcbios' direct disk image + directdisk-gpt Create a 'pcbios' direct disk image + mkefidisk Create an EFI disk image + directdisk Create a 'pcbios' direct disk image + systemd-bootdisk Create an EFI disk image with systemd-boot + mkhybridiso Create a hybrid ISO image + sdimage-bootpart Create SD card image with a boot partition + directdisk-multi-rootfs Create multi rootfs image using rootfs plugin + directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config - For image, you can provide - any of the following: + Once you know the list of available Wic images, you can use + help with the command to get help on a + particular image. + For example, the following command returns help on the + "beaglebone-yocto" image: - beaglebone - mpc8315e-rdb - genericx86 - edgerouter - qemux86-directdisk - directdisk-gpt - mkefidisk - directdisk - systemd-bootdisk - mkhybridiso - sdimage-bootpart - directdisk-multi-rootfs - directdisk-bootloader-config + $ wic list beaglebone-yocto help + + + Creates a partitioned SD card image for Beaglebone. + Boot files are located in the first vfat partition. @@ -5338,7 +5354,7 @@ Raw Mode: You explicitly specify build artifacts through - wic command-line arguments. + Wic command-line arguments. Cooked Mode: @@ -5433,7 +5449,7 @@ Running Wic in cooked mode leverages off artifacts in - Build Directory. + the Build Directory. In other words, you do not have to specify kernel or root filesystem locations as part of the command. All you need to provide is a kickstart file and the @@ -5485,9 +5501,9 @@ files: $ wic list images - beaglebone Create SD card image for Beaglebone mpc8315e-rdb Create SD card image for MPC8315E-RDB genericx86 Create an EFI disk image for genericx86* + beaglebone-yocto Create SD card image for Beaglebone edgerouter Create SD card image for Edgerouter qemux86-directdisk Create a qemu machine 'pcbios' direct disk image directdisk-gpt Create a 'pcbios' direct disk image @@ -5615,28 +5631,27 @@ prepare a partition using an implementation-specific function: - bootimg-pcbios.py . . . - class BootimgPcbiosPlugin(SourcePlugin): - """ - Create MBR boot partition and install syslinux on it. - """ + class BootimgPcbiosPlugin(SourcePlugin): + """ + Create MBR boot partition and install syslinux on it. + """ - name = 'bootimg-pcbios' + name = 'bootimg-pcbios' . . . - @classmethod - def do_prepare_partition(cls, part, source_params, creator, cr_workdir, - oe_builddir, bootimg_dir, kernel_dir, - rootfs_dir, native_sysroot): - """ - Called to do the actual content population for a partition i.e. it - 'prepares' the partition to be incorporated into the image. - In this case, prepare content for legacy bios boot partition. - """ + @classmethod + def do_prepare_partition(cls, part, source_params, creator, cr_workdir, + oe_builddir, bootimg_dir, kernel_dir, + rootfs_dir, native_sysroot): + """ + Called to do the actual content population for a partition i.e. it + 'prepares' the partition to be incorporated into the image. + In this case, prepare content for legacy bios boot partition. + """ . . . @@ -5745,9 +5760,11 @@
Generate an Image using an Existing Kickstart File - + This example runs in Cooked Mode and uses the mkefidisk kickstart file: + [OUTPUT IS WRONG DUE TO A BUG - ROOTFS_DIR AND BOOTIMG_DIR + ARE DISPLAYING TEMPORARY FILES THAT WIC CLEANS UP BY DELETING] $ wic create mkefidisk -e core-image-minimal INFO: Building wic-tools... @@ -5755,10 +5772,10 @@ . . INFO: The new image(s) can be found here: - ./mkefidisk-201710061409-sda.direct + ./mkefidisk-201802211426-sda.direct The following build artifacts were used to create the image(s): - ROOTFS_DIR: /home/scottrif/poky/build/tmp.wic.r4hkds0b/rootfs_copy + ROOTFS_DIR: /home/scottrif/poky/build/tmp.wic.zjs_iw41/rootfs_copy BOOTIMG_DIR: /home/scottrif/poky/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share KERNEL_DIR: /home/scottrif/poky/build/tmp/deploy/images/qemux86 NATIVE_SYSROOT: /home/scottrif/poky/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native @@ -5795,11 +5812,11 @@ bmaptool or dd: - $ oe-run-native bmaptool copy build/mkefidisk-201710061409-sda.direct /dev/sdX + $ oe-run-native bmaptool copy build/mkefidisk-201802211426-sda.direct /dev/sdX or - $ sudo dd if=build/mkefidisk-201710061409-sda.direct of=/dev/sdX + $ sudo dd if=build/mkefidisk-201802211426-sda.direct of=/dev/sdX For more information on how to use the -- cgit v1.2.3-54-g00ecf