dev-manual, ref-manual: Image format implementation changes

Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file.  The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.

Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml
index d127c4f5108c43b50267fcea06eb5f5a7b46c893..89589291fdedf6bc26e5e8f9efde8d201a0cc297 100644 (file)
--- a/documentation/dev-manual/dev-manual-qemu.xml
+++ b/documentation/dev-manual/dev-manual-qemu.xml
@@ -165,14 +165,14 @@
                             </literallayout>
                             </para></listitem>
                         <listitem><para>
-                            This example specifies to boot a virtual machine image
-                            (<filename>.vmdk</filename> file).
-                            From the <filename>.vmdk</filename>,
+                            This example specifies to boot a virtual machine
+                            image (<filename>.wic.vmdk</filename> file).
+                            From the <filename>.wic.vmdk</filename>,
                             <filename>runqemu</filename> determines the QEMU
                             architecture (<replaceable>MACHINE</replaceable>) to be
                             "qemux86" and the root filesystem type to be "vmdk".
                             <literallayout class='monospaced'>
-     $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.vmdk
+     $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk
                             </literallayout>
                             </para></listitem>
                     </itemizedlist>

diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 11605608e7ed420d9898bd58414591dd703b8db9..f4905acd616a2ade0ba0df3898e6e8aa893b1427 100644 (file)
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -3000,8 +3000,7 @@
                     from <filename>autotools</filename> instead.
                     </para></listitem>
                 <listitem><para><filename>boot-directdisk</filename>:
-                    Merged into the
-                    <link linkend='ref-classes-image-vm'><filename>image-vm</filename></link>
+                    Merged into the <filename>image-vm</filename>
                     class.
                     The <filename>boot-directdisk</filename> class was rarely
                     directly used.

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 4dd67578c305acec802b722d58718a638ba79f3e..48468c7f89599d2801621c940ab5fb74cf56a125 100644 (file)
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1286,14 +1286,15 @@
         <filename>image_types</filename> must also appear in
         <filename>IMAGE_CLASSES</filename>.
     </para>
-</section>
-
-<section id='ref-classes-image_types_uboot'>
-    <title><filename>image_types_uboot.bbclass</filename></title>
 
     <para>
-        The <filename>image_types_uboot</filename> class
-        defines additional image types specifically for the U-Boot bootloader.
+        This class also handles conversion and compression of images.
+        <note>
+            To build a VMware VMDK image, you need to add "wic.vmdk" to
+            <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
+            This would also be similar for Virtual Box Virtual Disk Image
+            ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images.
+        </note>
     </para>
 </section>
 
@@ -1370,27 +1371,6 @@
     </para>
 </section>
 
-<section id='ref-classes-image-vm'>
-    <title><filename>image-vm.bbclass</filename></title>
-
-    <para>
-        The <filename>image-vm</filename> class supports building VM
-        images.
-    </para>
-</section>
-
-<section id='ref-classes-image-vmdk'>
-    <title><filename>image-vmdk.bbclass</filename></title>
-
-    <para>
-        The <filename>image-vmdk</filename> class supports building VMware
-        VMDK images.
-        Normally, you do not use this class directly.
-        Instead, you add "vmdk" to
-        <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>.
-    </para>
-</section>
-
 <section id='ref-classes-insane'>
     <title><filename>insane.bbclass</filename></title>
 

diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 10c67ab52995db1398b7b07d4a1e7108a0af31e8..2d23bbaabf9e42958dd93be353674308240e5177 100644 (file)
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -842,16 +842,6 @@
             section in the Yocto Project Development Manual.
         </para>
     </section>
-
-    <section id='ref-tasks-vmdkimg'>
-        <title><filename>do_vmdkimg</filename></title>
-
-        <para>
-            Creates a <filename>.vmdk</filename> image for use with
-            <ulink url='http://www.vmware.com/'>VMware</ulink>
-            and compatible virtual machine hosts.
-        </para>
-    </section>
 </section>
 
 <section id='kernel-related-tasks'>

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8b1ca83938ee9977606b734b50045066e820a756..6f8721199bb687f05264a940e9eeda2cece2e6d3 100644 (file)
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3989,14 +3989,14 @@
 
         <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm>
             <info>
-                EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg or vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use."
+                EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg, iso, or live is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
                     When building bootable images (i.e. where
-                    <filename>hddimg</filename> or <filename>vmdk</filename>
-                    is in
+                    <filename>hddimg</filename>, <filename>iso</filename>,
+                    or <filename>vmdk</filename> is in
                     <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
                     the <filename>EFI_PROVIDER</filename> variable specifies
                     the EFI bootloader to use.
@@ -6315,7 +6315,6 @@
      jffs2
      jffs2.sum
      multiubi
-     qcow2
      squashfs
      squashfs-lzo
      squashfs-xz
@@ -6326,8 +6325,6 @@
      tar.xz
      ubi
      ubifs
-     vdi
-     vmdk
      wic
      wic.bz2
      wic.gz

diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index a96326834773ae957e3ab09fde7d78528c197a6b..f0614d5d5bf9f716fb040053b1347dae6f755d0c 100644 (file)
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -1243,11 +1243,11 @@
        runqemu qemux86-64 core-image-sato ext4
        runqemu qemux86-64 wic-image-minimal wic
        runqemu path/to/bzImage-qemux86.bin path/to/nfsrootdir/ serial
-       runqemu qemux86 iso/hddimg/vmdk/qcow2/vdi/ramfs/cpio.gz...
+       runqemu qemux86 iso/hddimg/wic.vmdk/wic.qcow2/wic.vdi/ramfs/cpio.gz...
        runqemu qemux86 qemuparams="-m 256"
        runqemu qemux86 bootparams="psplash=false"
-       runqemu path/to/<image>-<machine>.vmdk
        runqemu path/to/<image>-<machine>.wic
+       runqemu path/to/<image>-<machine>.wic.vmdk
             </literallayout>
         </para>
     </section>
@@ -1274,9 +1274,9 @@
                 <listitem><para>
                     <filename><replaceable>VM</replaceable></filename>:
                     The virtual machine image, which must be a
-                    <filename>.vmdk</filename> file.
+                    <filename>.wic.vmdk</filename> file.
                     Use this option when you want to boot a
-                    <filename>.vmdk</filename> image.
+                    <filename>.wic.vmdk</filename> image.
                     The image filename you provide must contain one of the
                     following strings: "qemux86-64", "qemux86", "qemuarm",
                     "qemumips64", "qemumips", "qemuppc", or "qemush4".