diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 79 |
1 files changed, 44 insertions, 35 deletions
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 @@ | |||
| 3451 | Usually, information about the hardware can tell you what image | 3451 | Usually, information about the hardware can tell you what image |
| 3452 | format the device requires. | 3452 | format the device requires. |
| 3453 | Should your device require multiple partitions on an SD card, flash, | 3453 | Should your device require multiple partitions on an SD card, flash, |
| 3454 | or an HDD, you can use the OpenEmbedded Image Creator | 3454 | or an HDD, you can use the OpenEmbedded Image Creator, |
| 3455 | to create the properly partitioned image. | 3455 | <filename>wic</filename>, to create the properly partitioned image. |
| 3456 | </para> | 3456 | </para> |
| 3457 | 3457 | ||
| 3458 | <para> | 3458 | <para> |
| @@ -3463,7 +3463,7 @@ | |||
| 3463 | specified either directly on the command-line or as one of a | 3463 | specified either directly on the command-line or as one of a |
| 3464 | selection of canned <filename>.wks</filename> files as shown | 3464 | selection of canned <filename>.wks</filename> files as shown |
| 3465 | with the <filename>wic list images</filename> command in the | 3465 | with the <filename>wic list images</filename> command in the |
| 3466 | "<link linkend='using-a-provided-kickstart_file'>Using a Provided Kickstart File</link>" | 3466 | "<link linkend='using-a-provided-kickstart_file'>Using an Existing Kickstart File</link>" |
| 3467 | section. | 3467 | section. |
| 3468 | When applied to a given set of build artifacts, the result is an | 3468 | When applied to a given set of build artifacts, the result is an |
| 3469 | image or set of images that can be directly written onto media and | 3469 | image or set of images that can be directly written onto media and |
| @@ -3533,9 +3533,9 @@ | |||
| 3533 | <title>Requirements</title> | 3533 | <title>Requirements</title> |
| 3534 | 3534 | ||
| 3535 | <para> | 3535 | <para> |
| 3536 | In order to use the <filename>wic</filename> utility with the | 3536 | In order to use the <filename>wic</filename> utility |
| 3537 | OpenEmbedded Build system, you need to meet the following | 3537 | with the OpenEmbedded Build system, your system needs |
| 3538 | requirements: | 3538 | to meet the following requirements: |
| 3539 | <itemizedlist> | 3539 | <itemizedlist> |
| 3540 | <listitem><para>The Linux distribution on your | 3540 | <listitem><para>The Linux distribution on your |
| 3541 | development host must support the Yocto Project. | 3541 | development host must support the Yocto Project. |
| @@ -3555,14 +3555,17 @@ | |||
| 3555 | system. | 3555 | system. |
| 3556 | </para></listitem> | 3556 | </para></listitem> |
| 3557 | <listitem><para> | 3557 | <listitem><para> |
| 3558 | Have the build artifacts already available. | 3558 | You need to have the build artifacts already |
| 3559 | You must already have created an image using the | 3559 | available, which typically means that you must |
| 3560 | have already created an image using the | ||
| 3560 | Openembedded build system (e.g. | 3561 | Openembedded build system (e.g. |
| 3561 | <filename>core-image-minimal</filename>. | 3562 | <filename>core-image-minimal</filename>). |
| 3562 | It might seem redundant to generate an image in order | 3563 | It might seem redundant to generate an image in |
| 3563 | to create an image using <filename>wic</filename>, | 3564 | order to create an image using |
| 3564 | but the artifacts are needed and they are generated | 3565 | <filename>wic</filename>, but in the current |
| 3565 | with the build system.</para></listitem> | 3566 | version <filename>wic</filename>, the artifacts |
| 3567 | are needed in the form generated by the build | ||
| 3568 | system.</para></listitem> | ||
| 3566 | <listitem><para> | 3569 | <listitem><para> |
| 3567 | You must have sourced one of the build environment | 3570 | You must have sourced one of the build environment |
| 3568 | setup scripts (i.e. | 3571 | setup scripts (i.e. |
| @@ -3613,8 +3616,8 @@ | |||
| 3613 | </para> | 3616 | </para> |
| 3614 | 3617 | ||
| 3615 | <para> | 3618 | <para> |
| 3616 | You can find more out about the images | 3619 | You can find out more about the images |
| 3617 | <filename>wic</filename> creates using the provided | 3620 | <filename>wic</filename> creates using the existing |
| 3618 | kickstart files with the following form of the command: | 3621 | kickstart files with the following form of the command: |
| 3619 | <literallayout class='monospaced'> | 3622 | <literallayout class='monospaced'> |
| 3620 | $ wic list <image> help | 3623 | $ wic list <image> help |
| @@ -3669,7 +3672,7 @@ | |||
| 3669 | <replaceable>image_name</replaceable>.wks | 3672 | <replaceable>image_name</replaceable>.wks |
| 3670 | An an OpenEmbedded kickstart file. You can provide | 3673 | An an OpenEmbedded kickstart file. You can provide |
| 3671 | your own custom file or use a file from a set of | 3674 | your own custom file or use a file from a set of |
| 3672 | provided files as described by further options. | 3675 | existing files as described by further options. |
| 3673 | 3676 | ||
| 3674 | -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable> | 3677 | -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable> |
| 3675 | The name of a directory in which to create image. | 3678 | The name of a directory in which to create image. |
| @@ -3743,19 +3746,19 @@ | |||
| 3743 | </section> | 3746 | </section> |
| 3744 | 3747 | ||
| 3745 | <section id='using-a-provided-kickstart_file'> | 3748 | <section id='using-a-provided-kickstart_file'> |
| 3746 | <title>Using a Provided Kickstart File</title> | 3749 | <title>Using an Existing Kickstart File</title> |
| 3747 | 3750 | ||
| 3748 | <para> | 3751 | <para> |
| 3749 | If you do not want to create your own | 3752 | If you do not want to create your own |
| 3750 | <filename>.wks</filename> file, you can use a provided | 3753 | <filename>.wks</filename> file, you can use an existing |
| 3751 | file. | 3754 | file provided by the <filename>wic</filename> installation. |
| 3752 | Use the following command to list the available files: | 3755 | Use the following command to list the available files: |
| 3753 | <literallayout class='monospaced'> | 3756 | <literallayout class='monospaced'> |
| 3754 | $ wic list images | 3757 | $ wic list images |
| 3755 | directdisk Create a 'pcbios' direct disk image | 3758 | directdisk Create a 'pcbios' direct disk image |
| 3756 | mkefidisk Create an EFI disk image | 3759 | mkefidisk Create an EFI disk image |
| 3757 | </literallayout> | 3760 | </literallayout> |
| 3758 | When you use a provided file, you do not have to use the | 3761 | When you use an existing file, you do not have to use the |
| 3759 | <filename>.wks</filename> extension. | 3762 | <filename>.wks</filename> extension. |
| 3760 | Here is an example in Raw Mode that uses the | 3763 | Here is an example in Raw Mode that uses the |
| 3761 | <filename>directdisk</filename> file: | 3764 | <filename>directdisk</filename> file: |
| @@ -3799,7 +3802,7 @@ | |||
| 3799 | </para> | 3802 | </para> |
| 3800 | 3803 | ||
| 3801 | <section id='generate-an-image-using-a-provided-kickstart-file'> | 3804 | <section id='generate-an-image-using-a-provided-kickstart-file'> |
| 3802 | <title>Generate an Image using a Provided Kickstart File</title> | 3805 | <title>Generate an Image using an Existing Kickstart File</title> |
| 3803 | 3806 | ||
| 3804 | <para> | 3807 | <para> |
| 3805 | This example runs in Cooked Mode and uses the | 3808 | This example runs in Cooked Mode and uses the |
| @@ -3826,7 +3829,7 @@ | |||
| 3826 | </literallayout> | 3829 | </literallayout> |
| 3827 | This example shows the easiest way to create an image | 3830 | This example shows the easiest way to create an image |
| 3828 | by running in Cooked Mode and using the | 3831 | by running in Cooked Mode and using the |
| 3829 | <filename>-e</filename> option with a provided kickstart | 3832 | <filename>-e</filename> option with an existing kickstart |
| 3830 | file. | 3833 | file. |
| 3831 | All that is necessary is to specify the image used to | 3834 | All that is necessary is to specify the image used to |
| 3832 | generate the artifacts. | 3835 | generate the artifacts. |
| @@ -3879,7 +3882,7 @@ | |||
| 3879 | <para> | 3882 | <para> |
| 3880 | As mentioned earlier, you can use the command | 3883 | As mentioned earlier, you can use the command |
| 3881 | <filename>wic list images</filename> to show the list | 3884 | <filename>wic list images</filename> to show the list |
| 3882 | of provided kickstart files. | 3885 | of existing kickstart files. |
| 3883 | The directory in which these files reside is | 3886 | The directory in which these files reside is |
| 3884 | <filename>scripts/lib/image/canned-wks/</filename> | 3887 | <filename>scripts/lib/image/canned-wks/</filename> |
| 3885 | located in the | 3888 | located in the |
| @@ -4199,15 +4202,21 @@ | |||
| 4199 | </para> | 4202 | </para> |
| 4200 | 4203 | ||
| 4201 | <para> | 4204 | <para> |
| 4202 | Following is a listing of the commands, their syntax, and | 4205 | The following is a list of the commands, their syntax, |
| 4203 | meanings. | 4206 | and meanings. |
| 4204 | The commands are based on the Fedora kickstart documentation | 4207 | The commands are based on the Fedora |
| 4205 | but with modifications to reflect <filename>wic</filename> | 4208 | kickstart documentation but with modifications to |
| 4206 | capabilities. | 4209 | reflect <filename>wic</filename> capabilities. |
| 4207 | <literallayout class='monospaced'> | 4210 | You can see the original documentation for those commands |
| 4208 | http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition | 4211 | at the following links: |
| 4209 | http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader | 4212 | <itemizedlist> |
| 4210 | </literallayout> | 4213 | <listitem><para> |
| 4214 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition</ulink> | ||
| 4215 | </para></listitem> | ||
| 4216 | <listitem><para> | ||
| 4217 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader</ulink> | ||
| 4218 | </para></listitem> | ||
| 4219 | </itemizedlist> | ||
| 4211 | </para> | 4220 | </para> |
| 4212 | 4221 | ||
| 4213 | <section id='command-part-or-partition'> | 4222 | <section id='command-part-or-partition'> |
| @@ -4323,8 +4332,8 @@ | |||
| 4323 | <listitem><para><emphasis><filename>--active</filename>:</emphasis> | 4332 | <listitem><para><emphasis><filename>--active</filename>:</emphasis> |
| 4324 | Marks the partition as active.</para></listitem> | 4333 | Marks the partition as active.</para></listitem> |
| 4325 | <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis> | 4334 | <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis> |
| 4326 | This option is specific to the Meego Image | 4335 | This option is a <filename>wic</filename>-specific |
| 4327 | Creator (mic) that says to start a partition on an | 4336 | option that says to start a partition on an |
| 4328 | x KBytes boundary.</para></listitem> | 4337 | x KBytes boundary.</para></listitem> |
| 4329 | </itemizedlist> | 4338 | </itemizedlist> |
| 4330 | </para> | 4339 | </para> |
| @@ -4358,7 +4367,7 @@ | |||
| 4358 | </para></listitem> | 4367 | </para></listitem> |
| 4359 | <listitem><para><emphasis><filename>--append</filename>:</emphasis> | 4368 | <listitem><para><emphasis><filename>--append</filename>:</emphasis> |
| 4360 | Specifies kernel parameters. | 4369 | Specifies kernel parameters. |
| 4361 | These will be added to the syslinux | 4370 | These parameters will be added to the syslinux |
| 4362 | <filename>APPEND</filename> or | 4371 | <filename>APPEND</filename> or |
| 4363 | <filename>grub</filename> kernel command line. | 4372 | <filename>grub</filename> kernel command line. |
| 4364 | </para></listitem> | 4373 | </para></listitem> |
