summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-01-27 14:23:48 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:46 -0800
commit2a0a3d631a67dee5a2592fef64ea203c42da8f7d (patch)
treea6e28411cd430a36f00cff7fd0e34307174e129c /documentation
parent57f3951f294a7193c742458bd65ad7f5e3cee652 (diff)
downloadpoky-2a0a3d631a67dee5a2592fef64ea203c42da8f7d.tar.gz
documentation/poky-ref-manual/extendpoky.xml: proposed section
This is a proposed section to describe how to customize an image through variable setting in the local.conf file. It is incomplete but needs to be checked out and discussed. (From yocto-docs rev: f995b01e9ec9dd12b62e514802000a7b76fe3126) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/extendpoky.xml64
1 files changed, 61 insertions, 3 deletions
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml
index 56b806de0b..8c1e343889 100644
--- a/documentation/poky-ref-manual/extendpoky.xml
+++ b/documentation/poky-ref-manual/extendpoky.xml
@@ -472,6 +472,64 @@
472 <title>Customizing Images Using <filename>local.conf</filename></title> 472 <title>Customizing Images Using <filename>local.conf</filename></title>
473 473
474 <para> 474 <para>
475 While not recommended, it is possible to include or exclude packages in the
476 image by setting variables in the <filename>conf/local.conf</filename> file in
477 the Yocto Project build directory.
478 <note>
479 The best way to add packages to an image is to create a layer that contains
480 recipes to specifically add the packages.
481 Using variables with the <filename>local.conf</filename> to add things
482 to images could result in ordering problems or even leave you with a
483 build system that seemingly adds "random" packages to the image.
484 For example, if you use the same or a copied <filename>local.conf</filename>
485 for another project, you might have forgotten about something you added
486 for a previous project.
487 </note>
488 This section describes some of the ways you could include or exclude packages
489 in the image through use of the <filename>conf/local.conf</filename> file.
490 </para>
491
492 <section id='adding-packages'>
493 <title>Adding Packages</title>
494
495 <para>
496 Following are some methods to add packages to the image through the
497 use of variables in the <filename>conf/local.conf</filename>:
498 <itemizedlist>
499 <listitem><para><emphasis><filename>IMAGE_INSTALL_append</filename> - </emphasis>
500 Some explanation</para></listitem>
501 <listitem><para><emphasis><filename>POKY_EXTRA_append</filename> - </emphasis>
502 Some explanation</para></listitem>
503 <listitem><para><emphasis><filename>POKY_EXTRA_INSTALL</filename> - </emphasis>
504 Some explanation</para></listitem>
505 </itemizedlist>
506 </para>
507 </section>
508
509 <section id='excluding-packages'>
510 <title>Excluding Packages</title>
511
512 <para>
513 It is possible to filter or mask out recipe and recipe append files such that
514 BitBake ignores them.
515 You can do this by providing an expression with the
516 <filename>BBMASK</filename> variable.
517 Here is an example:
518 <literallayout class='monospaced'>
519 BBMASK = ".*/meta-mymachine/recipes-maybe/"
520 </literallayout>
521 Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files
522 in the directory that matches the expression are ignored during the build
523 process.
524 </para>
525 </section>
526<!--
527THIS IS THE ORIGINAL STUFF
528
529 <section id='usingpoky-extend-customimage-localconf'>
530 <title>Customizing Images Using <filename>local.conf</filename></title>
531
532 <para>
475 It is possible to customize image contents by using variables used by distribution 533 It is possible to customize image contents by using variables used by distribution
476 maintainers in the <filename>local.conf</filename> found in the Yocto Project 534 maintainers in the <filename>local.conf</filename> found in the Yocto Project
477 build directory. 535 build directory.
@@ -489,9 +547,8 @@
489 <para> 547 <para>
490 However, since the 548 However, since the
491 <filename><link linkend='var-DISTRO_EXTRA_RDEPENDS'>DISTRO_EXTRA_RDEPENDS</link></filename> 549 <filename><link linkend='var-DISTRO_EXTRA_RDEPENDS'>DISTRO_EXTRA_RDEPENDS</link></filename>
492 variable is for 550 variable is for distribution maintainers, adding packages using this method is not
493 distribution maintainers, adding packages using this method is not as simple as adding 551 as simple as adding them using a custom <filename>.bb</filename> file.
494 them using a custom <filename>.bb</filename> file.
495 Using the <filename>local.conf</filename> file method could result in some packages 552 Using the <filename>local.conf</filename> file method could result in some packages
496 needing to be recreated. 553 needing to be recreated.
497 For example, if packages were previously created and the image was rebuilt, then the packages 554 For example, if packages were previously created and the image was rebuilt, then the packages
@@ -512,6 +569,7 @@
512 $ bitbake core-image-sato 569 $ bitbake core-image-sato
513 </literallayout> 570 </literallayout>
514 </para> 571 </para>
572 </section> -->
515 </section> 573 </section>
516 </section> 574 </section>
517 575