diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-09-30 11:33:27 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-09-30 21:37:43 +0100 |
commit | 6d843e633665eeedbe44765b87ac234739ab50a8 (patch) | |
tree | 803973020b683ce871d2e9463f12744901d97877 | |
parent | 380ec32a4dc5a5f568567d088804607e51c660bc (diff) | |
download | poky-6d843e633665eeedbe44765b87ac234739ab50a8.tar.gz |
ref-manual: Edits to the "Image Features" section layout
I updated the section to have two lists of features. One list
is for features that work only when you inherit the core-image
class. The other list is for features that are available for
all images regargless of inheriting this class.
(From yocto-docs rev: 9d1bcab2a9264e64db2dec66247aaf55493ae362)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 118 |
1 files changed, 56 insertions, 62 deletions
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 604c843b89..174f44f3e7 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml | |||
@@ -220,33 +220,11 @@ | |||
220 | </para> | 220 | </para> |
221 | 221 | ||
222 | <para> | 222 | <para> |
223 | The bulk of image features are available only when you inherit the | 223 | Some image features are available only when you inherit the |
224 | <link linkend='ref-classes-core-image'><filename>core-image</filename></link> | 224 | <link linkend='ref-classes-core-image'><filename>core-image</filename></link> |
225 | class. | 225 | class. |
226 | However, some features, as noted in the following list, are | 226 | The current list of these valid variables is as follows: |
227 | available to all images. | ||
228 | The current list of valid <filename>IMAGE_FEATURES</filename> | ||
229 | is as follows: | ||
230 | <itemizedlist> | 227 | <itemizedlist> |
231 | <listitem><para><emphasis>dbg-pkgs:</emphasis> | ||
232 | Installs debug symbol packages for all packages installed | ||
233 | in a given image. | ||
234 | </para></listitem> | ||
235 | <listitem><para><emphasis>debug-tweaks:</emphasis> | ||
236 | Makes an image suitable for development (e.g. | ||
237 | allows root logins without passwords). | ||
238 | The <filename>debug-tweaks</filename> feature is | ||
239 | available for all images regardless of whether or not | ||
240 | the <filename>core-image</filename> class is inherited. | ||
241 | </para></listitem> | ||
242 | <listitem><para><emphasis>dev-pkgs:</emphasis> | ||
243 | Installs development packages (headers and extra library | ||
244 | links) for all packages installed in a given image. | ||
245 | </para></listitem> | ||
246 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs | ||
247 | documentation packages for all packages installed in a | ||
248 | given image. | ||
249 | </para></listitem> | ||
250 | <listitem><para><emphasis>eclipse-debug:</emphasis> Provides | 228 | <listitem><para><emphasis>eclipse-debug:</emphasis> Provides |
251 | Eclipse remote debugging support. | 229 | Eclipse remote debugging support. |
252 | </para></listitem> | 230 | </para></listitem> |
@@ -256,42 +234,9 @@ | |||
256 | <listitem><para><emphasis>nfs-server:</emphasis> | 234 | <listitem><para><emphasis>nfs-server:</emphasis> |
257 | Installs an NFS server. | 235 | Installs an NFS server. |
258 | </para></listitem> | 236 | </para></listitem> |
259 | <listitem><para><emphasis>package-management:</emphasis> | ||
260 | Installs package management tools and preserves the package | ||
261 | manager database. | ||
262 | The <filename>package-management</filename> feature is | ||
263 | available for all images regardless of whether or not | ||
264 | the <filename>core-image</filename> class is inherited. | ||
265 | </para></listitem> | ||
266 | <listitem><para><emphasis>ptest-pkgs:</emphasis> | ||
267 | Installs ptest packages for all ptest-enabled recipes. | ||
268 | </para></listitem> | ||
269 | <listitem><para><emphasis>qt4-pkgs:</emphasis> | 237 | <listitem><para><emphasis>qt4-pkgs:</emphasis> |
270 | Supports Qt4/X11 and demo applications. | 238 | Supports Qt4/X11 and demo applications. |
271 | </para></listitem> | 239 | </para></listitem> |
272 | <listitem><para><emphasis>read-only-rootfs:</emphasis> | ||
273 | Creates an image whose root filesystem is read-only. | ||
274 | See the | ||
275 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" | ||
276 | section in the Yocto Project Development Manual for more | ||
277 | information. | ||
278 | The <filename>read-only-rootfs</filename> feature is | ||
279 | available for all images regardless of whether or not | ||
280 | the <filename>core-image</filename> class is inherited. | ||
281 | </para></listitem> | ||
282 | <listitem><para><emphasis>splash:</emphasis> | ||
283 | Enables showing a splash screen during boot. | ||
284 | By default, this screen is provided by | ||
285 | <filename>psplash</filename>, which does allow | ||
286 | customization. | ||
287 | If you prefer to use an alternative splash screen package, | ||
288 | you can do so by setting the <filename>SPLASH</filename> | ||
289 | variable to a different package name (or names) within the | ||
290 | image recipe or at the distro configuration level. | ||
291 | The <filename>splash</filename> feature is | ||
292 | available for all images regardless of whether or not | ||
293 | the <filename>core-image</filename> class is inherited. | ||
294 | </para></listitem> | ||
295 | <listitem><para><emphasis>ssh-server-dropbear:</emphasis> | 240 | <listitem><para><emphasis>ssh-server-dropbear:</emphasis> |
296 | Installs the Dropbear minimal SSH server. | 241 | Installs the Dropbear minimal SSH server. |
297 | </para></listitem> | 242 | </para></listitem> |
@@ -303,11 +248,6 @@ | |||
303 | <filename>IMAGE_FEATURES</filename>, then OpenSSH will take | 248 | <filename>IMAGE_FEATURES</filename>, then OpenSSH will take |
304 | precedence and Dropbear will not be installed. | 249 | precedence and Dropbear will not be installed. |
305 | </para></listitem> | 250 | </para></listitem> |
306 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> | ||
307 | Installs static development packages (i.e. static | ||
308 | libraries containing <filename>*.a</filename> files) for | ||
309 | all packages installed in a given image. | ||
310 | </para></listitem> | ||
311 | <listitem><para><emphasis>tools-debug:</emphasis> | 251 | <listitem><para><emphasis>tools-debug:</emphasis> |
312 | Installs debugging tools such as | 252 | Installs debugging tools such as |
313 | <filename>strace</filename> and <filename>gdb</filename>. | 253 | <filename>strace</filename> and <filename>gdb</filename>. |
@@ -343,6 +283,60 @@ | |||
343 | </para></listitem> | 283 | </para></listitem> |
344 | </itemizedlist> | 284 | </itemizedlist> |
345 | </para> | 285 | </para> |
286 | |||
287 | <para> | ||
288 | Other image features are available for all images regardless of | ||
289 | whether or not you inherit the <filename>core-image</filename> | ||
290 | class. | ||
291 | The list of these valid variables is as follows: | ||
292 | <itemizedlist> | ||
293 | <listitem><para><emphasis>dbg-pkgs:</emphasis> | ||
294 | Installs debug symbol packages for all packages installed | ||
295 | in a given image. | ||
296 | </para></listitem> | ||
297 | <listitem><para><emphasis>debug-tweaks:</emphasis> | ||
298 | Makes an image suitable for development (e.g. | ||
299 | allows root logins without passwords). | ||
300 | </para></listitem> | ||
301 | <listitem><para><emphasis>dev-pkgs:</emphasis> | ||
302 | Installs development packages (headers and extra library | ||
303 | links) for all packages installed in a given image. | ||
304 | </para></listitem> | ||
305 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs | ||
306 | documentation packages for all packages installed in a | ||
307 | given image. | ||
308 | </para></listitem> | ||
309 | <listitem><para><emphasis>package-management:</emphasis> | ||
310 | Installs package management tools and preserves the package | ||
311 | manager database. | ||
312 | </para></listitem> | ||
313 | <listitem><para><emphasis>ptest-pkgs:</emphasis> | ||
314 | Installs ptest packages for all ptest-enabled recipes. | ||
315 | </para></listitem> | ||
316 | <listitem><para><emphasis>read-only-rootfs:</emphasis> | ||
317 | Creates an image whose root filesystem is read-only. | ||
318 | See the | ||
319 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" | ||
320 | section in the Yocto Project Development Manual for more | ||
321 | information. | ||
322 | </para></listitem> | ||
323 | <listitem><para><emphasis>splash:</emphasis> | ||
324 | Enables showing a splash screen during boot. | ||
325 | By default, this screen is provided by | ||
326 | <filename>psplash</filename>, which does allow | ||
327 | customization. | ||
328 | If you prefer to use an alternative splash screen package, | ||
329 | you can do so by setting the <filename>SPLASH</filename> | ||
330 | variable to a different package name (or names) within the | ||
331 | image recipe or at the distro configuration level. | ||
332 | </para></listitem> | ||
333 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> | ||
334 | Installs static development packages (i.e. static | ||
335 | libraries containing <filename>*.a</filename> files) for | ||
336 | all packages installed in a given image. | ||
337 | </para></listitem> | ||
338 | </itemizedlist> | ||
339 | </para> | ||
346 | </section> | 340 | </section> |
347 | 341 | ||
348 | <section id='ref-features-backfill'> | 342 | <section id='ref-features-backfill'> |