diff options
author | Paul Eggleton <paul.eggleton@linux.intel.com> | 2012-09-05 08:48:29 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-09-14 09:50:46 +0100 |
commit | b39457ccc67e9351ca2daa7db1db1a23866731f1 (patch) | |
tree | a3572827620401ca467a62ab3d3c75ceacec58ee /documentation/dev-manual | |
parent | 84b3daaf50b4c196e7c28951941d1824631fe570 (diff) | |
download | poky-b39457ccc67e9351ca2daa7db1db1a23866731f1.tar.gz |
documentation/dev-manual/dev-manual-common-tasks.xml: package group changes
Task has been renamed to package group, and there are some minor changes
in how package group recipes should be constructed - in particular the
inherit of packagegroup.bbclass is now highly recommended as it will set
appropriate defaults and automatically add complementary -dev and -dbg
packages.
In addition to Paul's patch, I added a couple <filename>/</filename>
tags around some switch names to be consistent with manual
formatting.
(From yocto-docs rev: 598d18507ace2054f8c8bb5f496557c98f066b5a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index bdf59de8a6..e456d540a0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -465,7 +465,7 @@ | |||
465 | One way to get additional software into an image is to create a custom image. | 465 | One way to get additional software into an image is to create a custom image. |
466 | The following example shows the form for the two lines you need: | 466 | The following example shows the form for the two lines you need: |
467 | <literallayout class='monospaced'> | 467 | <literallayout class='monospaced'> |
468 | IMAGE_INSTALL = "task-core-x11-base package1 package2" | 468 | IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2" |
469 | 469 | ||
470 | inherit core-image | 470 | inherit core-image |
471 | </literallayout> | 471 | </literallayout> |
@@ -494,58 +494,60 @@ | |||
494 | </section> | 494 | </section> |
495 | 495 | ||
496 | <section id='usingpoky-extend-customimage-customtasks'> | 496 | <section id='usingpoky-extend-customimage-customtasks'> |
497 | <title>Customizing Images Using Custom Tasks</title> | 497 | <title>Customizing Images Using Custom Package Groups</title> |
498 | 498 | ||
499 | <para> | 499 | <para> |
500 | For complex custom images, the best approach is to create a custom task package | 500 | For complex custom images, the best approach is to create a custom package group recipe |
501 | that is used to build the image or images. | 501 | that is used to build the image or images. |
502 | A good example of a tasks package is | 502 | A good example of a package group recipe is |
503 | <filename>meta/recipes-core/tasks/task-core-boot.bb</filename> | 503 | <filename>meta/recipes-core/packagegroups/packagegroup-core-boot.bb</filename>. |
504 | The | 504 | The |
505 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> | 505 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> |
506 | variable lists the task packages to build along with the complementary | 506 | variable lists the package group packages you wish to produce. <filename>inherit packagegroup</filename> |
507 | <filename>-dbg</filename> and <filename>-dev</filename> packages. | 507 | sets appropriate default values and automatically adds <filename>-dev</filename> |
508 | For each package added, you can use | 508 | and <filename>-dbg</filename> complementary |
509 | packages for every package specified in <filename>PACKAGES</filename>. | ||
510 | Note that the inherit line should be towards | ||
511 | the top of the recipe, certainly before you set <filename>PACKAGES</filename>. | ||
512 | For each package you specify in <filename>PACKAGES</filename>, you can use | ||
509 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename> | 513 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename> |
510 | and | 514 | and |
511 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> | 515 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> |
512 | entries to provide a list of packages the parent task package should contain. | 516 | entries to provide a list of packages the parent task package should contain. |
513 | Following is an example: | 517 | Following is an example: |
514 | <literallayout class='monospaced'> | 518 | <literallayout class='monospaced'> |
515 | DESCRIPTION = "My Custom Tasks" | 519 | DESCRIPTION = "My Custom Package Groups" |
520 | |||
521 | inherit packagegroup | ||
516 | 522 | ||
517 | PACKAGES = "\ | 523 | PACKAGES = "\ |
518 | task-custom-apps \ | 524 | packagegroup-custom-apps \ |
519 | task-custom-apps-dbg \ | 525 | packagegroup-custom-tools \ |
520 | task-custom-apps-dev \ | ||
521 | task-custom-tools \ | ||
522 | task-custom-tools-dbg \ | ||
523 | task-custom-tools-dev \ | ||
524 | " | 526 | " |
525 | 527 | ||
526 | RDEPENDS_task-custom-apps = "\ | 528 | RDEPENDS_packagegroup-custom-apps = "\ |
527 | dropbear \ | 529 | dropbear \ |
528 | portmap \ | 530 | portmap \ |
529 | psplash" | 531 | psplash" |
530 | 532 | ||
531 | RDEPENDS_task-custom-tools = "\ | 533 | RDEPENDS_packagegroup-custom-tools = "\ |
532 | oprofile \ | 534 | oprofile \ |
533 | oprofileui-server \ | 535 | oprofileui-server \ |
534 | lttng-control \ | 536 | lttng-control \ |
535 | lttng-viewer" | 537 | lttng-viewer" |
536 | 538 | ||
537 | RRECOMMENDS_task-custom-tools = "\ | 539 | RRECOMMENDS_packagegroup-custom-tools = "\ |
538 | kernel-module-oprofile" | 540 | kernel-module-oprofile" |
539 | </literallayout> | 541 | </literallayout> |
540 | </para> | 542 | </para> |
541 | 543 | ||
542 | <para> | 544 | <para> |
543 | In the previous example, two task packages are created with their dependencies and their | 545 | In the previous example, two package group packages are created with their dependencies and their |
544 | recommended package dependencies listed: <filename>task-custom-apps</filename>, and | 546 | recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and |
545 | <filename>task-custom-tools</filename>. | 547 | <filename>packagegroup-custom-tools</filename>. |
546 | To build an image using these task packages, you need to add | 548 | To build an image using these packagegroup packages, you need to add |
547 | <filename>task-custom-apps</filename> and/or | 549 | <filename>packagegroup-custom-apps</filename> and/or |
548 | <filename>task-custom-tools</filename> to | 550 | <filename>packagegroup-custom-tools</filename> to |
549 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. | 551 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. |
550 | For other forms of image dependencies see the other areas of this section. | 552 | For other forms of image dependencies see the other areas of this section. |
551 | </para> | 553 | </para> |