diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-10-16 16:31:19 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-10-18 16:15:30 +0200 |
| commit | 2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (patch) | |
| tree | ace8abdef240fafd3bdbeed9001e67da40d7cbd8 /documentation/ref-manual/ref-images.xml | |
| parent | b96378eb6b2443301b04dfc83eecf36eced6a27c (diff) | |
| download | poky-2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b.tar.gz | |
ref-manual: Scrubbed for variable (user) input.
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-images.xml')
| -rw-r--r-- | documentation/ref-manual/ref-images.xml | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml index 503595c364..d15ca5b93a 100644 --- a/documentation/ref-manual/ref-images.xml +++ b/documentation/ref-manual/ref-images.xml | |||
| @@ -38,9 +38,9 @@ | |||
| 38 | </para> | 38 | </para> |
| 39 | 39 | ||
| 40 | <para> | 40 | <para> |
| 41 | Following, is a list of supported recipes: | 41 | Following is a list of supported recipes: |
| 42 | <itemizedlist> | 42 | <itemizedlist> |
| 43 | <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis> | 43 | <listitem><para><filename>build-appliance-image</filename>: |
| 44 | An example virtual machine that contains all the pieces required to | 44 | An example virtual machine that contains all the pieces required to |
| 45 | run builds using the build system as well as the build system itself. | 45 | run builds using the build system as well as the build system itself. |
| 46 | You can boot and run the image using either the | 46 | You can boot and run the image using either the |
| @@ -49,18 +49,18 @@ | |||
| 49 | For more information on this image, see the | 49 | For more information on this image, see the |
| 50 | <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on | 50 | <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on |
| 51 | the Yocto Project website.</para></listitem> | 51 | the Yocto Project website.</para></listitem> |
| 52 | <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> | 52 | <listitem><para><filename>core-image-base</filename>: |
| 53 | A console-only image that fully supports the target device hardware.</para></listitem> | 53 | A console-only image that fully supports the target device hardware.</para></listitem> |
| 54 | <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> | 54 | <listitem><para><filename>core-image-clutter</filename>: |
| 55 | An image with support for the Open GL-based toolkit Clutter, which enables development of | 55 | An image with support for the Open GL-based toolkit Clutter, which enables development of |
| 56 | rich and animated graphical user interfaces.</para></listitem> | 56 | rich and animated graphical user interfaces.</para></listitem> |
| 57 | <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis> | 57 | <listitem><para><filename>core-image-directfb</filename>: |
| 58 | An image that uses <filename>directfb</filename> instead of X11. | 58 | An image that uses <filename>directfb</filename> instead of X11. |
| 59 | </para></listitem> | 59 | </para></listitem> |
| 60 | <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis> | 60 | <listitem><para><filename>core-image-full-cmdline</filename>: |
| 61 | A console-only image with more full-featured Linux system | 61 | A console-only image with more full-featured Linux system |
| 62 | functionality installed.</para></listitem> | 62 | functionality installed.</para></listitem> |
| 63 | <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> | 63 | <listitem><para><filename>core-image-lsb</filename>: |
| 64 | An image that conforms to the Linux Standard Base (LSB) | 64 | An image that conforms to the Linux Standard Base (LSB) |
| 65 | specification. | 65 | specification. |
| 66 | This image requires a distribution configuration that | 66 | This image requires a distribution configuration that |
| @@ -68,7 +68,7 @@ | |||
| 68 | If you build <filename>core-image-lsb</filename> without that | 68 | If you build <filename>core-image-lsb</filename> without that |
| 69 | configuration, the image will not be LSB-compliant. | 69 | configuration, the image will not be LSB-compliant. |
| 70 | </para></listitem> | 70 | </para></listitem> |
| 71 | <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> | 71 | <listitem><para><filename>core-image-lsb-dev</filename>: |
| 72 | A <filename>core-image-lsb</filename> image that is suitable for development work | 72 | A <filename>core-image-lsb</filename> image that is suitable for development work |
| 73 | using the host. | 73 | using the host. |
| 74 | The image includes headers and libraries you can use in a host development | 74 | The image includes headers and libraries you can use in a host development |
| @@ -78,7 +78,7 @@ | |||
| 78 | If you build <filename>core-image-lsb-dev</filename> without that | 78 | If you build <filename>core-image-lsb-dev</filename> without that |
| 79 | configuration, the image will not be LSB-compliant. | 79 | configuration, the image will not be LSB-compliant. |
| 80 | </para></listitem> | 80 | </para></listitem> |
| 81 | <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> | 81 | <listitem><para><filename>core-image-lsb-sdk</filename>: |
| 82 | A <filename>core-image-lsb</filename> that includes everything in | 82 | A <filename>core-image-lsb</filename> that includes everything in |
| 83 | meta-toolchain but also includes development headers and libraries | 83 | meta-toolchain but also includes development headers and libraries |
| 84 | to form a complete standalone SDK. | 84 | to form a complete standalone SDK. |
| @@ -87,15 +87,15 @@ | |||
| 87 | If you build <filename>core-image-lsb-sdk</filename> without that | 87 | If you build <filename>core-image-lsb-sdk</filename> without that |
| 88 | configuration, the image will not be LSB-compliant. | 88 | configuration, the image will not be LSB-compliant. |
| 89 | This image is suitable for development using the target.</para></listitem> | 89 | This image is suitable for development using the target.</para></listitem> |
| 90 | <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> | 90 | <listitem><para><filename>core-image-minimal</filename>: |
| 91 | A small image just capable of allowing a device to boot.</para></listitem> | 91 | A small image just capable of allowing a device to boot.</para></listitem> |
| 92 | <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis> | 92 | <listitem><para><filename>core-image-minimal-dev</filename>: |
| 93 | A <filename>core-image-minimal</filename> image suitable for development work | 93 | A <filename>core-image-minimal</filename> image suitable for development work |
| 94 | using the host. | 94 | using the host. |
| 95 | The image includes headers and libraries you can use in a host development | 95 | The image includes headers and libraries you can use in a host development |
| 96 | environment. | 96 | environment. |
| 97 | </para></listitem> | 97 | </para></listitem> |
| 98 | <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> | 98 | <listitem><para id='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename>: |
| 99 | A <filename>core-image-minimal</filename> image that has the Minimal RAM-based | 99 | A <filename>core-image-minimal</filename> image that has the Minimal RAM-based |
| 100 | Initial Root Filesystem (initramfs) as part of the kernel, | 100 | Initial Root Filesystem (initramfs) as part of the kernel, |
| 101 | which allows the system to find the first “init” program more efficiently. | 101 | which allows the system to find the first “init” program more efficiently. |
| @@ -104,38 +104,38 @@ | |||
| 104 | variable for additional information helpful when working with | 104 | variable for additional information helpful when working with |
| 105 | initramfs images. | 105 | initramfs images. |
| 106 | </para></listitem> | 106 | </para></listitem> |
| 107 | <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> | 107 | <listitem><para><filename>core-image-minimal-mtdutils</filename>: |
| 108 | A <filename>core-image-minimal</filename> image that has support | 108 | A <filename>core-image-minimal</filename> image that has support |
| 109 | for the Minimal MTD Utilities, which let the user interact with the | 109 | for the Minimal MTD Utilities, which let the user interact with the |
| 110 | MTD subsystem in the kernel to perform operations on flash devices. | 110 | MTD subsystem in the kernel to perform operations on flash devices. |
| 111 | </para></listitem> | 111 | </para></listitem> |
| 112 | <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> | 112 | <listitem><para><filename>core-image-rt</filename>: |
| 113 | A <filename>core-image-minimal</filename> image plus a real-time test suite and | 113 | A <filename>core-image-minimal</filename> image plus a real-time test suite and |
| 114 | tools appropriate for real-time use.</para></listitem> | 114 | tools appropriate for real-time use.</para></listitem> |
| 115 | <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> | 115 | <listitem><para><filename>core-image-rt-sdk</filename>: |
| 116 | A <filename>core-image-rt</filename> image that includes everything in | 116 | A <filename>core-image-rt</filename> image that includes everything in |
| 117 | <filename>meta-toolchain</filename>. | 117 | <filename>meta-toolchain</filename>. |
| 118 | The image also includes development headers and libraries to form a complete | 118 | The image also includes development headers and libraries to form a complete |
| 119 | stand-alone SDK and is suitable for development using the target. | 119 | stand-alone SDK and is suitable for development using the target. |
| 120 | </para></listitem> | 120 | </para></listitem> |
| 121 | <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> | 121 | <listitem><para><filename>core-image-sato</filename>: |
| 122 | An image with Sato support, a mobile environment and visual style that works well | 122 | An image with Sato support, a mobile environment and visual style that works well |
| 123 | with mobile devices. | 123 | with mobile devices. |
| 124 | The image supports X11 with a Sato theme and applications such as | 124 | The image supports X11 with a Sato theme and applications such as |
| 125 | a terminal, editor, file manager, media player, and so forth. | 125 | a terminal, editor, file manager, media player, and so forth. |
| 126 | </para></listitem> | 126 | </para></listitem> |
| 127 | <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> | 127 | <listitem><para><filename>core-image-sato-dev</filename>: |
| 128 | A <filename>core-image-sato</filename> image suitable for development | 128 | A <filename>core-image-sato</filename> image suitable for development |
| 129 | using the host. | 129 | using the host. |
| 130 | The image includes libraries needed to build applications on the device itself, | 130 | The image includes libraries needed to build applications on the device itself, |
| 131 | testing and profiling tools, and debug symbols. | 131 | testing and profiling tools, and debug symbols. |
| 132 | This image was formerly <filename>core-image-sdk</filename>. | 132 | This image was formerly <filename>core-image-sdk</filename>. |
| 133 | </para></listitem> | 133 | </para></listitem> |
| 134 | <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> | 134 | <listitem><para><filename>core-image-sato-sdk</filename>: |
| 135 | A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. | 135 | A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. |
| 136 | The image also includes development headers and libraries to form a complete standalone SDK | 136 | The image also includes development headers and libraries to form a complete standalone SDK |
| 137 | and is suitable for development using the target.</para></listitem> | 137 | and is suitable for development using the target.</para></listitem> |
| 138 | <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis> | 138 | <listitem><para><filename>core-image-testmaster</filename>: |
| 139 | A "master" image designed to be used for automated runtime testing. | 139 | A "master" image designed to be used for automated runtime testing. |
| 140 | Provides a "known good" image that is deployed to a separate | 140 | Provides a "known good" image that is deployed to a separate |
| 141 | partition so that you can boot into it and use it to deploy a | 141 | partition so that you can boot into it and use it to deploy a |
| @@ -144,21 +144,21 @@ | |||
| 144 | "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" | 144 | "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" |
| 145 | section in the Yocto Project Development Manual. | 145 | section in the Yocto Project Development Manual. |
| 146 | </para></listitem> | 146 | </para></listitem> |
| 147 | <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis> | 147 | <listitem><para><filename>core-image-testmaster-initramfs</filename>: |
| 148 | A RAM-based Initial Root Filesystem (initramfs) image tailored for | 148 | A RAM-based Initial Root Filesystem (initramfs) image tailored for |
| 149 | use with the <filename>core-image-testmaster</filename> image. | 149 | use with the <filename>core-image-testmaster</filename> image. |
| 150 | </para></listitem> | 150 | </para></listitem> |
| 151 | <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis> | 151 | <listitem><para><filename>core-image-weston</filename>: |
| 152 | A very basic Wayland image with a terminal. | 152 | A very basic Wayland image with a terminal. |
| 153 | This image provides the Wayland protocol libraries and the | 153 | This image provides the Wayland protocol libraries and the |
| 154 | reference Weston compositor. | 154 | reference Weston compositor. |
| 155 | For more information, see the | 155 | For more information, see the |
| 156 | "<link linkend='wayland'>Wayland</link>" section. | 156 | "<link linkend='wayland'>Wayland</link>" section. |
| 157 | </para></listitem> | 157 | </para></listitem> |
| 158 | <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis> | 158 | <listitem><para><filename>core-image-x11</filename>: |
| 159 | A very basic X11 image with a terminal. | 159 | A very basic X11 image with a terminal. |
| 160 | </para></listitem> | 160 | </para></listitem> |
| 161 | <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis> | 161 | <listitem><para><filename>qt4e-demo-image</filename>: |
| 162 | An image that launches into the demo application for the embedded | 162 | An image that launches into the demo application for the embedded |
| 163 | (not based on X11) version of Qt.</para></listitem> | 163 | (not based on X11) version of Qt.</para></listitem> |
| 164 | </itemizedlist> | 164 | </itemizedlist> |
