diff options
Diffstat (limited to 'documentation/ref-manual/ref-images.xml')
| -rw-r--r-- | documentation/ref-manual/ref-images.xml | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml new file mode 100644 index 0000000000..37c8051a26 --- /dev/null +++ b/documentation/ref-manual/ref-images.xml | |||
| @@ -0,0 +1,150 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | |||
| 5 | <chapter id='ref-images'> | ||
| 6 | <title>Images</title> | ||
| 7 | |||
| 8 | <para> | ||
| 9 | The OpenEmbedded build system provides several example | ||
| 10 | images to satisfy different needs. | ||
| 11 | When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe | ||
| 12 | that essentially begins the build for the type of image you want. | ||
| 13 | </para> | ||
| 14 | |||
| 15 | <note> | ||
| 16 | Building an image without GNU General Public License Version 3 (GPLv3) components | ||
| 17 | is only supported for minimal and base images. | ||
| 18 | Furthermore, if you are going to build an image using non-GPLv3 components, | ||
| 19 | you must make the following changes in the <filename>local.conf</filename> file | ||
| 20 | before using the BitBake command to build the minimal or base image: | ||
| 21 | <literallayout class='monospaced'> | ||
| 22 | 1. Comment out the EXTRA_IMAGE_FEATURES line | ||
| 23 | 2. Set INCOMPATIBLE_LICENSE = "GPLv3" | ||
| 24 | </literallayout> | ||
| 25 | </note> | ||
| 26 | |||
| 27 | <para> | ||
| 28 | From within the <filename>poky</filename> Git repository, use the following command to list | ||
| 29 | the supported images: | ||
| 30 | <literallayout class='monospaced'> | ||
| 31 | $ ls meta*/recipes*/images/*.bb | ||
| 32 | </literallayout> | ||
| 33 | These recipes reside in the <filename>meta/recipes-core/images</filename>, | ||
| 34 | <filename>meta/recipes-extended/images</filename>, | ||
| 35 | <filename>meta/recipes-graphics/images</filename>, | ||
| 36 | <filename>meta/recipes-qt/images</filename>, | ||
| 37 | <filename>meta/recipes-rt/images</filename>, | ||
| 38 | <filename>meta/recipes-sato/images</filename>, and | ||
| 39 | <filename>meta-skeleton/recipes-multilib/images</filename> directories | ||
| 40 | within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
| 41 | Although the recipe names are somewhat explanatory, here is a list that describes them: | ||
| 42 | </para> | ||
| 43 | |||
| 44 | <itemizedlist> | ||
| 45 | <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis> | ||
| 46 | An example virtual machine that contains all the pieces required to | ||
| 47 | run builds using the build system as well as the build system itself. | ||
| 48 | You can boot and run the image using either the | ||
| 49 | <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink> | ||
| 50 | or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>. | ||
| 51 | For more information on this image, see the | ||
| 52 | <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on | ||
| 53 | the Yocto Project website.</para></listitem> | ||
| 54 | <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> | ||
| 55 | A console-only image that fully supports the target device hardware.</para></listitem> | ||
| 56 | <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> | ||
| 57 | A small image just capable of allowing a device to boot.</para></listitem> | ||
| 58 | <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis> | ||
| 59 | A <filename>core-image-minimal</filename> image suitable for development work | ||
| 60 | using the host. | ||
| 61 | The image includes headers and libraries you can use in a host development | ||
| 62 | environment. | ||
| 63 | </para></listitem> | ||
| 64 | <listitem><para><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> | ||
| 65 | A <filename>core-image-minimal</filename> image that has the Minimal RAM-based | ||
| 66 | Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel, | ||
| 67 | which allows the system to find the first “init” program more efficiently. | ||
| 68 | </para></listitem> | ||
| 69 | <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> | ||
| 70 | A <filename>core-image-minimal</filename> image that has support | ||
| 71 | for the Minimal MTD Utilities, which let the user interact with the | ||
| 72 | MTD subsystem in the kernel to perform operations on flash devices. | ||
| 73 | </para></listitem> | ||
| 74 | <listitem><para><emphasis><filename>core-image-basic</filename>:</emphasis> | ||
| 75 | A console-only image with more full-featured Linux system | ||
| 76 | functionality installed.</para></listitem> | ||
| 77 | <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> | ||
| 78 | An image that conforms to the Linux Standard Base (LSB) specification. | ||
| 79 | </para></listitem> | ||
| 80 | <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> | ||
| 81 | A <filename>core-image-lsb</filename> image that is suitable for development work | ||
| 82 | using the host. | ||
| 83 | The image includes headers and libraries you can use in a host development | ||
| 84 | environment. | ||
| 85 | </para></listitem> | ||
| 86 | <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> | ||
| 87 | A <filename>core-image-lsb</filename> that includes everything in meta-toolchain | ||
| 88 | but also includes development headers and libraries to form a complete standalone SDK. | ||
| 89 | This image is suitable for development using the target.</para></listitem> | ||
| 90 | <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> | ||
| 91 | An image with support for the Open GL-based toolkit Clutter, which enables development of | ||
| 92 | rich and animated graphical user interfaces.</para></listitem> | ||
| 93 | <listitem><para><emphasis><filename>core-image-gtk-directfb</filename>:</emphasis> | ||
| 94 | An image that uses <filename>gtk+</filename> over <filename>directfb</filename> | ||
| 95 | instead of X11. | ||
| 96 | In order to build, this image requires specific distro configuration that enables | ||
| 97 | <filename>gtk</filename> over <filename>directfb</filename>.</para></listitem> | ||
| 98 | <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis> | ||
| 99 | A very basic X11 image with a terminal. | ||
| 100 | </para></listitem> | ||
| 101 | <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis> | ||
| 102 | An image that launches into the demo application for the embedded | ||
| 103 | (not based on X11) version of Qt.</para></listitem> | ||
| 104 | <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> | ||
| 105 | A <filename>core-image-minimal</filename> image plus a real-time test suite and | ||
| 106 | tools appropriate for real-time use.</para></listitem> | ||
| 107 | <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> | ||
| 108 | A <filename>core-image-rt</filename> image that includes everything in | ||
| 109 | <filename>meta-toolchain</filename>. | ||
| 110 | The image also includes development headers and libraries to form a complete | ||
| 111 | stand-alone SDK and is suitable for development using the target. | ||
| 112 | </para></listitem> | ||
| 113 | <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> | ||
| 114 | An image with Sato support, a mobile environment and visual style that works well | ||
| 115 | with mobile devices. | ||
| 116 | The image supports X11 with a Sato theme and applications such as | ||
| 117 | a terminal, editor, file manager, media player, and so forth. | ||
| 118 | </para></listitem> | ||
| 119 | <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> | ||
| 120 | A <filename>core-image-sato</filename> image suitable for development | ||
| 121 | using the host. | ||
| 122 | The image includes libraries needed to build applications on the device itself, | ||
| 123 | testing and profiling tools, and debug symbols. | ||
| 124 | This image was formerly <filename>core-image-sdk</filename>. | ||
| 125 | </para></listitem> | ||
| 126 | <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> | ||
| 127 | A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. | ||
| 128 | The image also includes development headers and libraries to form a complete standalone SDK | ||
| 129 | and is suitable for development using the target.</para></listitem> | ||
| 130 | <listitem><para><emphasis><filename>core-image-multilib-example</filename>:</emphasis> | ||
| 131 | An example image that includes a <filename>lib32</filename> version | ||
| 132 | of Bash into an otherwise standard <filename>sato</filename> image. | ||
| 133 | The image assumes a "lib32" multilib has been enabled in the your | ||
| 134 | configuration.</para></listitem> | ||
| 135 | </itemizedlist> | ||
| 136 | |||
| 137 | <tip> | ||
| 138 | From the Yocto Project release 1.1 onwards, <filename>-live</filename> and | ||
| 139 | <filename>-directdisk</filename> images have been replaced by a "live" | ||
| 140 | option in <filename>IMAGE_FSTYPES</filename> that will work with any image to produce an | ||
| 141 | image file that can be | ||
| 142 | copied directly to a CD or USB device and run as is. | ||
| 143 | To build a live image, simply add | ||
| 144 | "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename> | ||
| 145 | file or wherever appropriate and then build the desired image as normal. | ||
| 146 | </tip> | ||
| 147 | </chapter> | ||
| 148 | <!-- | ||
| 149 | vim: expandtab tw=80 ts=4 | ||
| 150 | --> | ||