From 7ef076cd9eac5aa1eabc8162d2f99fa2ab07428b Mon Sep 17 00:00:00 2001 From: Tom Zanussi Date: Wed, 30 Jul 2014 11:12:36 +0300 Subject: dev-manual: Miscellaneous wic edits. This is a set of fixes for miscellaneous dev-manual updates noticed while transcribing wic help for the dev manual. (From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 79 ++++++++++++---------- 1 file changed, 44 insertions(+), 35 deletions(-) (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index b995371c10..5a3901d9c5 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -3451,8 +3451,8 @@ Usually, information about the hardware can tell you what image format the device requires. Should your device require multiple partitions on an SD card, flash, - or an HDD, you can use the OpenEmbedded Image Creator - to create the properly partitioned image. + or an HDD, you can use the OpenEmbedded Image Creator, + wic, to create the properly partitioned image. @@ -3463,7 +3463,7 @@ specified either directly on the command-line or as one of a selection of canned .wks files as shown with the wic list images command in the - "Using a Provided Kickstart File" + "Using an Existing Kickstart File" section. When applied to a given set of build artifacts, the result is an image or set of images that can be directly written onto media and @@ -3533,9 +3533,9 @@ Requirements - In order to use the wic utility with the - OpenEmbedded Build system, you need to meet the following - requirements: + In order to use the wic utility + with the OpenEmbedded Build system, your system needs + to meet the following requirements: The Linux distribution on your development host must support the Yocto Project. @@ -3555,14 +3555,17 @@ system. - Have the build artifacts already available. - You must already have created an image using the + You need to have the build artifacts already + available, which typically means that you must + have already created an image using the Openembedded build system (e.g. - core-image-minimal. - It might seem redundant to generate an image in order - to create an image using wic, - but the artifacts are needed and they are generated - with the build system. + core-image-minimal). + It might seem redundant to generate an image in + order to create an image using + wic, but in the current + version wic, the artifacts + are needed in the form generated by the build + system. You must have sourced one of the build environment setup scripts (i.e. @@ -3613,8 +3616,8 @@ - You can find more out about the images - wic creates using the provided + You can find out more about the images + wic creates using the existing kickstart files with the following form of the command: $ wic list <image> help @@ -3669,7 +3672,7 @@ image_name.wks An an OpenEmbedded kickstart file. You can provide your own custom file or use a file from a set of - provided files as described by further options. + existing files as described by further options. -o OUTDIR, --outdir=OUTDIR The name of a directory in which to create image. @@ -3743,19 +3746,19 @@
- Using a Provided Kickstart File + Using an Existing Kickstart File If you do not want to create your own - .wks file, you can use a provided - file. + .wks file, you can use an existing + file provided by the wic installation. Use the following command to list the available files: $ wic list images directdisk Create a 'pcbios' direct disk image mkefidisk Create an EFI disk image - When you use a provided file, you do not have to use the + When you use an existing file, you do not have to use the .wks extension. Here is an example in Raw Mode that uses the directdisk file: @@ -3799,7 +3802,7 @@
- Generate an Image using a Provided Kickstart File + Generate an Image using an Existing Kickstart File This example runs in Cooked Mode and uses the @@ -3826,7 +3829,7 @@ This example shows the easiest way to create an image by running in Cooked Mode and using the - -e option with a provided kickstart + -e option with an existing kickstart file. All that is necessary is to specify the image used to generate the artifacts. @@ -3879,7 +3882,7 @@ As mentioned earlier, you can use the command wic list images to show the list - of provided kickstart files. + of existing kickstart files. The directory in which these files reside is scripts/lib/image/canned-wks/ located in the @@ -4199,15 +4202,21 @@ - Following is a listing of the commands, their syntax, and - meanings. - The commands are based on the Fedora kickstart documentation - but with modifications to reflect wic - capabilities. - - http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition - http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader - + The following is a list of the commands, their syntax, + and meanings. + The commands are based on the Fedora + kickstart documentation but with modifications to + reflect wic capabilities. + You can see the original documentation for those commands + at the following links: + + + http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition + + + http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader + +
@@ -4323,8 +4332,8 @@ --active: Marks the partition as active. --align (in KBytes): - This option is specific to the Meego Image - Creator (mic) that says to start a partition on an + This option is a wic-specific + option that says to start a partition on an x KBytes boundary. @@ -4358,7 +4367,7 @@ --append: Specifies kernel parameters. - These will be added to the syslinux + These parameters will be added to the syslinux APPEND or grub kernel command line. -- cgit v1.2.3-54-g00ecf