diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-02-21 17:30:12 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-03-03 08:35:24 +0000 |
commit | e21faa4a9cc4b29ff8aa094877d14256cfd280ba (patch) | |
tree | cfc03930ca691e2f5b842b0325ee060328a9b1df /documentation | |
parent | 3461d890d312744d15e680ba8e923505610277bf (diff) | |
download | poky-e21faa4a9cc4b29ff8aa094877d14256cfd280ba.tar.gz |
dev-manual: Updated Wic example using existing kickstart file.
(From yocto-docs rev: a1f25bd6aae35e4c052e348949bea332b9203c20)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 125 |
1 files changed, 71 insertions, 54 deletions
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 @@ | |||
5268 | <literallayout class='monospaced'> | 5268 | <literallayout class='monospaced'> |
5269 | $ wic -h | 5269 | $ wic -h |
5270 | $ wic --help | 5270 | $ wic --help |
5271 | $ wic help | ||
5271 | </literallayout> | 5272 | </literallayout> |
5272 | </para> | 5273 | </para> |
5273 | 5274 | ||
@@ -5277,51 +5278,66 @@ | |||
5277 | <filename>help</filename>, <filename>list</filename>, | 5278 | <filename>help</filename>, <filename>list</filename>, |
5278 | <filename>ls</filename>, <filename>rm</filename>, and | 5279 | <filename>ls</filename>, <filename>rm</filename>, and |
5279 | <filename>write</filename>. | 5280 | <filename>write</filename>. |
5280 | You can get help for these commands as follows with | 5281 | You can get help for all these commands except "help" by |
5281 | <replaceable>command</replaceable> being one of the | 5282 | using the following form: |
5282 | supported commands: | ||
5283 | <literallayout class='monospaced'> | 5283 | <literallayout class='monospaced'> |
5284 | $ wic help <replaceable>command</replaceable> | 5284 | $ wic help <replaceable>command</replaceable> |
5285 | </literallayout> | 5285 | </literallayout> |
5286 | For example, the following command returns help for the | ||
5287 | <filename>write</filename> command: | ||
5288 | <literallayout class='monospaced'> | ||
5289 | $ wic help write | ||
5290 | </literallayout> | ||
5286 | </para> | 5291 | </para> |
5287 | 5292 | ||
5288 | <para> | 5293 | <para> |
5289 | You can also get detailed help on a number of topics | 5294 | Wic supports help for three topics: |
5290 | from the help system. | 5295 | <filename>overview</filename>, |
5291 | The output of <filename>wic --help</filename> | 5296 | <filename>plugins</filename>, and |
5292 | displays a list of available help | 5297 | <filename>kickstart</filename>. |
5293 | topics under a "Help topics" heading. | 5298 | You can get help for any topic using the following form: |
5294 | You can have the help system display the help text for | ||
5295 | a given topic by prefacing the topic with | ||
5296 | <filename>wic help</filename>: | ||
5297 | <literallayout class='monospaced'> | 5299 | <literallayout class='monospaced'> |
5298 | $ wic help <replaceable>help_topic</replaceable> | 5300 | $ wic help <replaceable>topic</replaceable> |
5301 | </literallayout> | ||
5302 | For example, the following returns overview help for Wic: | ||
5303 | <literallayout class='monospaced'> | ||
5304 | $ wic help overview | ||
5299 | </literallayout> | 5305 | </literallayout> |
5300 | </para> | 5306 | </para> |
5301 | 5307 | ||
5302 | <para> | 5308 | <para> |
5303 | You can find out more about the images Wic creates using | 5309 | One additional level of help exists for Wic. |
5304 | the existing kickstart files with the following form of | 5310 | You can get help on individual images through the |
5305 | the command: | 5311 | <filename>list</filename> command. |
5312 | You can use the <filename>list</filename> command to return the | ||
5313 | available Wic images as follows: | ||
5306 | <literallayout class='monospaced'> | 5314 | <literallayout class='monospaced'> |
5307 | $ wic list <replaceable>image</replaceable> help | 5315 | $ wic list images |
5316 | mpc8315e-rdb Create SD card image for MPC8315E-RDB | ||
5317 | genericx86 Create an EFI disk image for genericx86* | ||
5318 | beaglebone-yocto Create SD card image for Beaglebone | ||
5319 | edgerouter Create SD card image for Edgerouter | ||
5320 | qemux86-directdisk Create a qemu machine 'pcbios' direct disk image | ||
5321 | directdisk-gpt Create a 'pcbios' direct disk image | ||
5322 | mkefidisk Create an EFI disk image | ||
5323 | directdisk Create a 'pcbios' direct disk image | ||
5324 | systemd-bootdisk Create an EFI disk image with systemd-boot | ||
5325 | mkhybridiso Create a hybrid ISO image | ||
5326 | sdimage-bootpart Create SD card image with a boot partition | ||
5327 | directdisk-multi-rootfs Create multi rootfs image using rootfs plugin | ||
5328 | directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config | ||
5308 | </literallayout> | 5329 | </literallayout> |
5309 | For <replaceable>image</replaceable>, you can provide | 5330 | Once you know the list of available Wic images, you can use |
5310 | any of the following: | 5331 | <filename>help</filename> with the command to get help on a |
5332 | particular image. | ||
5333 | For example, the following command returns help on the | ||
5334 | "beaglebone-yocto" image: | ||
5311 | <literallayout class='monospaced'> | 5335 | <literallayout class='monospaced'> |
5312 | beaglebone | 5336 | $ wic list beaglebone-yocto help |
5313 | mpc8315e-rdb | 5337 | |
5314 | genericx86 | 5338 | |
5315 | edgerouter | 5339 | Creates a partitioned SD card image for Beaglebone. |
5316 | qemux86-directdisk | 5340 | Boot files are located in the first vfat partition. |
5317 | directdisk-gpt | ||
5318 | mkefidisk | ||
5319 | directdisk | ||
5320 | systemd-bootdisk | ||
5321 | mkhybridiso | ||
5322 | sdimage-bootpart | ||
5323 | directdisk-multi-rootfs | ||
5324 | directdisk-bootloader-config | ||
5325 | </literallayout> | 5341 | </literallayout> |
5326 | </para> | 5342 | </para> |
5327 | </section> | 5343 | </section> |
@@ -5338,7 +5354,7 @@ | |||
5338 | <listitem><para> | 5354 | <listitem><para> |
5339 | <emphasis>Raw Mode:</emphasis> | 5355 | <emphasis>Raw Mode:</emphasis> |
5340 | You explicitly specify build artifacts through | 5356 | You explicitly specify build artifacts through |
5341 | <filename>wic</filename> command-line arguments. | 5357 | Wic command-line arguments. |
5342 | </para></listitem> | 5358 | </para></listitem> |
5343 | <listitem><para> | 5359 | <listitem><para> |
5344 | <emphasis>Cooked Mode:</emphasis> | 5360 | <emphasis>Cooked Mode:</emphasis> |
@@ -5433,7 +5449,7 @@ | |||
5433 | 5449 | ||
5434 | <para> | 5450 | <para> |
5435 | Running Wic in cooked mode leverages off artifacts in | 5451 | Running Wic in cooked mode leverages off artifacts in |
5436 | Build Directory. | 5452 | the Build Directory. |
5437 | In other words, you do not have to specify kernel or | 5453 | In other words, you do not have to specify kernel or |
5438 | root filesystem locations as part of the command. | 5454 | root filesystem locations as part of the command. |
5439 | All you need to provide is a kickstart file and the | 5455 | All you need to provide is a kickstart file and the |
@@ -5485,9 +5501,9 @@ | |||
5485 | files: | 5501 | files: |
5486 | <literallayout class='monospaced'> | 5502 | <literallayout class='monospaced'> |
5487 | $ wic list images | 5503 | $ wic list images |
5488 | beaglebone Create SD card image for Beaglebone | ||
5489 | mpc8315e-rdb Create SD card image for MPC8315E-RDB | 5504 | mpc8315e-rdb Create SD card image for MPC8315E-RDB |
5490 | genericx86 Create an EFI disk image for genericx86* | 5505 | genericx86 Create an EFI disk image for genericx86* |
5506 | beaglebone-yocto Create SD card image for Beaglebone | ||
5491 | edgerouter Create SD card image for Edgerouter | 5507 | edgerouter Create SD card image for Edgerouter |
5492 | qemux86-directdisk Create a qemu machine 'pcbios' direct disk image | 5508 | qemux86-directdisk Create a qemu machine 'pcbios' direct disk image |
5493 | directdisk-gpt Create a 'pcbios' direct disk image | 5509 | directdisk-gpt Create a 'pcbios' direct disk image |
@@ -5615,28 +5631,27 @@ | |||
5615 | prepare a partition using an implementation-specific | 5631 | prepare a partition using an implementation-specific |
5616 | function: | 5632 | function: |
5617 | <literallayout class='monospaced'> | 5633 | <literallayout class='monospaced'> |
5618 | bootimg-pcbios.py | ||
5619 | . | 5634 | . |
5620 | . | 5635 | . |
5621 | . | 5636 | . |
5622 | class BootimgPcbiosPlugin(SourcePlugin): | 5637 | class BootimgPcbiosPlugin(SourcePlugin): |
5623 | """ | 5638 | """ |
5624 | Create MBR boot partition and install syslinux on it. | 5639 | Create MBR boot partition and install syslinux on it. |
5625 | """ | 5640 | """ |
5626 | 5641 | ||
5627 | name = 'bootimg-pcbios' | 5642 | name = 'bootimg-pcbios' |
5628 | . | 5643 | . |
5629 | . | 5644 | . |
5630 | . | 5645 | . |
5631 | @classmethod | 5646 | @classmethod |
5632 | def do_prepare_partition(cls, part, source_params, creator, cr_workdir, | 5647 | def do_prepare_partition(cls, part, source_params, creator, cr_workdir, |
5633 | oe_builddir, bootimg_dir, kernel_dir, | 5648 | oe_builddir, bootimg_dir, kernel_dir, |
5634 | rootfs_dir, native_sysroot): | 5649 | rootfs_dir, native_sysroot): |
5635 | """ | 5650 | """ |
5636 | Called to do the actual content population for a partition i.e. it | 5651 | Called to do the actual content population for a partition i.e. it |
5637 | 'prepares' the partition to be incorporated into the image. | 5652 | 'prepares' the partition to be incorporated into the image. |
5638 | In this case, prepare content for legacy bios boot partition. | 5653 | In this case, prepare content for legacy bios boot partition. |
5639 | """ | 5654 | """ |
5640 | . | 5655 | . |
5641 | . | 5656 | . |
5642 | . | 5657 | . |
@@ -5745,9 +5760,11 @@ | |||
5745 | <section id='generate-an-image-using-a-provided-kickstart-file'> | 5760 | <section id='generate-an-image-using-a-provided-kickstart-file'> |
5746 | <title>Generate an Image using an Existing Kickstart File</title> | 5761 | <title>Generate an Image using an Existing Kickstart File</title> |
5747 | 5762 | ||
5748 | <para> | 5763 | <para role='writernotes'> |
5749 | This example runs in Cooked Mode and uses the | 5764 | This example runs in Cooked Mode and uses the |
5750 | <filename>mkefidisk</filename> kickstart file: | 5765 | <filename>mkefidisk</filename> kickstart file: |
5766 | [OUTPUT IS WRONG DUE TO A BUG - ROOTFS_DIR AND BOOTIMG_DIR | ||
5767 | ARE DISPLAYING TEMPORARY FILES THAT WIC CLEANS UP BY DELETING] | ||
5751 | <literallayout class='monospaced'> | 5768 | <literallayout class='monospaced'> |
5752 | $ wic create mkefidisk -e core-image-minimal | 5769 | $ wic create mkefidisk -e core-image-minimal |
5753 | INFO: Building wic-tools... | 5770 | INFO: Building wic-tools... |
@@ -5755,10 +5772,10 @@ | |||
5755 | . | 5772 | . |
5756 | . | 5773 | . |
5757 | INFO: The new image(s) can be found here: | 5774 | INFO: The new image(s) can be found here: |
5758 | ./mkefidisk-201710061409-sda.direct | 5775 | ./mkefidisk-201802211426-sda.direct |
5759 | 5776 | ||
5760 | The following build artifacts were used to create the image(s): | 5777 | The following build artifacts were used to create the image(s): |
5761 | ROOTFS_DIR: /home/scottrif/poky/build/tmp.wic.r4hkds0b/rootfs_copy | 5778 | ROOTFS_DIR: /home/scottrif/poky/build/tmp.wic.zjs_iw41/rootfs_copy |
5762 | BOOTIMG_DIR: /home/scottrif/poky/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share | 5779 | BOOTIMG_DIR: /home/scottrif/poky/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/recipe-sysroot/usr/share |
5763 | KERNEL_DIR: /home/scottrif/poky/build/tmp/deploy/images/qemux86 | 5780 | KERNEL_DIR: /home/scottrif/poky/build/tmp/deploy/images/qemux86 |
5764 | NATIVE_SYSROOT: /home/scottrif/poky/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native | 5781 | NATIVE_SYSROOT: /home/scottrif/poky/build/tmp/work/i586-poky-linux/wic-tools/1.0-r0/recipe-sysroot-native |
@@ -5795,11 +5812,11 @@ | |||
5795 | <filename>bmaptool</filename> or | 5812 | <filename>bmaptool</filename> or |
5796 | <filename>dd</filename>: | 5813 | <filename>dd</filename>: |
5797 | <literallayout class='monospaced'> | 5814 | <literallayout class='monospaced'> |
5798 | $ oe-run-native bmaptool copy build/mkefidisk-201710061409-sda.direct /dev/sd<replaceable>X</replaceable> | 5815 | $ oe-run-native bmaptool copy build/mkefidisk-201802211426-sda.direct /dev/sd<replaceable>X</replaceable> |
5799 | </literallayout> | 5816 | </literallayout> |
5800 | or | 5817 | or |
5801 | <literallayout class='monospaced'> | 5818 | <literallayout class='monospaced'> |
5802 | $ sudo dd if=build/mkefidisk-201710061409-sda.direct of=/dev/sd<replaceable>X</replaceable> | 5819 | $ sudo dd if=build/mkefidisk-201802211426-sda.direct of=/dev/sd<replaceable>X</replaceable> |
5803 | </literallayout> | 5820 | </literallayout> |
5804 | <note> | 5821 | <note> |
5805 | For more information on how to use the | 5822 | For more information on how to use the |