diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 122 |
1 files changed, 59 insertions, 63 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index f55e99122b..793b4c78c6 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -599,71 +599,47 @@ | |||
599 | what you require. | 599 | what you require. |
600 | </para> | 600 | </para> |
601 | 601 | ||
602 | <section id='adding-packages'> | 602 | <para> |
603 | <title>Adding Packages</title> | 603 | The simplest way to add extra packages to all images is by using the |
604 | 604 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> | |
605 | <para> | 605 | variable with the <filename>_append</filename> operator: |
606 | The simplest way to add extra packages to all images is by using the | 606 | <literallayout class='monospaced'> |
607 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> | ||
608 | variable with the <filename>_append</filename> operator: | ||
609 | <literallayout class='monospaced'> | ||
610 | IMAGE_INSTALL_append = " strace" | 607 | IMAGE_INSTALL_append = " strace" |
611 | </literallayout> | 608 | </literallayout> |
612 | Use of the syntax is important. | 609 | Use of the syntax is important. |
613 | Specifically, the space between the quote and the package name, which is | 610 | Specifically, the space between the quote and the package name, which is |
614 | <filename>strace</filename> in this example. | 611 | <filename>strace</filename> in this example. |
615 | This space is required since the <filename>_append</filename> | 612 | This space is required since the <filename>_append</filename> |
616 | operator does not add the space. | 613 | operator does not add the space. |
617 | </para> | 614 | </para> |
618 | 615 | ||
619 | <para> | 616 | <para> |
620 | Furthermore, you must use <filename>_append</filename> instead of the <filename>+=</filename> | 617 | Furthermore, you must use <filename>_append</filename> instead of the <filename>+=</filename> |
621 | operator if you want to avoid ordering issues. | 618 | operator if you want to avoid ordering issues. |
622 | The reason for this is because doing so unconditionally appends to the variable and | 619 | The reason for this is because doing so unconditionally appends to the variable and |
623 | avoids ordering problems due to the variable being set in image recipes and | 620 | avoids ordering problems due to the variable being set in image recipes and |
624 | <filename>.bbclass</filename> files with operators like <filename>?=</filename>. | 621 | <filename>.bbclass</filename> files with operators like <filename>?=</filename>. |
625 | Using <filename>_append</filename> ensures the operation takes affect. | 622 | Using <filename>_append</filename> ensures the operation takes affect. |
626 | </para> | 623 | </para> |
627 | 624 | ||
628 | <para> | 625 | <para> |
629 | As shown in its simplest use, <filename>IMAGE_INSTALL_append</filename> affects | 626 | As shown in its simplest use, <filename>IMAGE_INSTALL_append</filename> affects |
630 | all images. | 627 | all images. |
631 | It is possible to extend the syntax so that the variable applies to a specific image only. | 628 | It is possible to extend the syntax so that the variable applies to a specific image only. |
632 | Here is an example: | 629 | Here is an example: |
633 | <literallayout class='monospaced'> | 630 | <literallayout class='monospaced'> |
634 | IMAGE_INSTALL_append_pn-core-image-minimal = " strace" | 631 | IMAGE_INSTALL_append_pn-core-image-minimal = " strace" |
635 | </literallayout> | 632 | </literallayout> |
636 | This example adds <filename>strace</filename> to <filename>core-image-minimal</filename> | 633 | This example adds <filename>strace</filename> to <filename>core-image-minimal</filename> |
637 | only. | 634 | only. |
638 | </para> | 635 | </para> |
639 | 636 | ||
640 | <para> | 637 | <para> |
641 | You can add packages using a similar approach through the | 638 | You can add packages using a similar approach through the |
642 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'>CORE_IMAGE_EXTRA_INSTALL</ulink></filename> | 639 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'>CORE_IMAGE_EXTRA_INSTALL</ulink></filename> |
643 | variable. | 640 | variable. |
644 | If you use this variable, only <filename>core-image-*</filename> images are affected. | 641 | If you use this variable, only <filename>core-image-*</filename> images are affected. |
645 | </para> | 642 | </para> |
646 | </section> | ||
647 | |||
648 | <section id='excluding-packages'> | ||
649 | <title>Excluding Packages</title> | ||
650 | |||
651 | <para> | ||
652 | It is possible to filter or mask out <filename>.bb</filename> and | ||
653 | <filename>.bbappend</filename> files such that BitBake ignores them during | ||
654 | the build. | ||
655 | You can do this by providing an expression with the | ||
656 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> | ||
657 | variable. | ||
658 | Here is an example: | ||
659 | <literallayout class='monospaced'> | ||
660 | BBMASK = ".*/meta-mymachine/recipes-maybe/" | ||
661 | </literallayout> | ||
662 | Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files | ||
663 | in the directory that matches the expression are ignored during the build | ||
664 | process. | ||
665 | </para> | ||
666 | </section> | ||
667 | </section> | 643 | </section> |
668 | </section> | 644 | </section> |
669 | 645 | ||
@@ -2013,6 +1989,26 @@ so that there are some definite steps on how to do this. I need more detail her | |||
2013 | build directory that is different than the source directory. | 1989 | build directory that is different than the source directory. |
2014 | </para> | 1990 | </para> |
2015 | </section> | 1991 | </section> |
1992 | |||
1993 | <section id='excluding-packages-from-the-build'> | ||
1994 | <title>Excluding Packages From the Build</title> | ||
1995 | |||
1996 | <para> | ||
1997 | It is possible to filter or mask out <filename>.bb</filename> and | ||
1998 | <filename>.bbappend</filename> files such that BitBake ignores them during | ||
1999 | the build. | ||
2000 | You can do this by providing an expression with the | ||
2001 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> | ||
2002 | variable. | ||
2003 | Here is an example: | ||
2004 | <literallayout class='monospaced'> | ||
2005 | BBMASK = ".*/meta-mymachine/recipes-maybe/" | ||
2006 | </literallayout> | ||
2007 | Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files | ||
2008 | in the directory that match the expression are ignored during the build | ||
2009 | process - BitBake does not even parse them. | ||
2010 | </para> | ||
2011 | </section> | ||
2016 | </chapter> | 2012 | </chapter> |
2017 | 2013 | ||
2018 | <!-- | 2014 | <!-- |