1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-02 01:19:52 +00:00

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>
This commit is contained in:
Paul Eggleton
2012-09-05 08:48:29 -07:00
committed by Richard Purdie
parent 84b3daaf50
commit b39457ccc6
@@ -465,7 +465,7 @@
One way to get additional software into an image is to create a custom image. One way to get additional software into an image is to create a custom image.
The following example shows the form for the two lines you need: The following example shows the form for the two lines you need:
<literallayout class='monospaced'> <literallayout class='monospaced'>
IMAGE_INSTALL = "task-core-x11-base package1 package2" IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2"
inherit core-image inherit core-image
</literallayout> </literallayout>
@@ -494,58 +494,60 @@
</section> </section>
<section id='usingpoky-extend-customimage-customtasks'> <section id='usingpoky-extend-customimage-customtasks'>
<title>Customizing Images Using Custom Tasks</title> <title>Customizing Images Using Custom Package Groups</title>
<para> <para>
For complex custom images, the best approach is to create a custom task package For complex custom images, the best approach is to create a custom package group recipe
that is used to build the image or images. that is used to build the image or images.
A good example of a tasks package is A good example of a package group recipe is
<filename>meta/recipes-core/tasks/task-core-boot.bb</filename> <filename>meta/recipes-core/packagegroups/packagegroup-core-boot.bb</filename>.
The The
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename>
variable lists the task packages to build along with the complementary variable lists the package group packages you wish to produce. <filename>inherit packagegroup</filename>
<filename>-dbg</filename> and <filename>-dev</filename> packages. sets appropriate default values and automatically adds <filename>-dev</filename>
For each package added, you can use and <filename>-dbg</filename> complementary
packages for every package specified in <filename>PACKAGES</filename>.
Note that the inherit line should be towards
the top of the recipe, certainly before you set <filename>PACKAGES</filename>.
For each package you specify in <filename>PACKAGES</filename>, you can use
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename> <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename>
and and
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename>
entries to provide a list of packages the parent task package should contain. entries to provide a list of packages the parent task package should contain.
Following is an example: Following is an example:
<literallayout class='monospaced'> <literallayout class='monospaced'>
DESCRIPTION = "My Custom Tasks" DESCRIPTION = "My Custom Package Groups"
inherit packagegroup
PACKAGES = "\ PACKAGES = "\
task-custom-apps \ packagegroup-custom-apps \
task-custom-apps-dbg \ packagegroup-custom-tools \
task-custom-apps-dev \
task-custom-tools \
task-custom-tools-dbg \
task-custom-tools-dev \
" "
RDEPENDS_task-custom-apps = "\ RDEPENDS_packagegroup-custom-apps = "\
dropbear \ dropbear \
portmap \ portmap \
psplash" psplash"
RDEPENDS_task-custom-tools = "\ RDEPENDS_packagegroup-custom-tools = "\
oprofile \ oprofile \
oprofileui-server \ oprofileui-server \
lttng-control \ lttng-control \
lttng-viewer" lttng-viewer"
RRECOMMENDS_task-custom-tools = "\ RRECOMMENDS_packagegroup-custom-tools = "\
kernel-module-oprofile" kernel-module-oprofile"
</literallayout> </literallayout>
</para> </para>
<para> <para>
In the previous example, two task packages are created with their dependencies and their In the previous example, two package group packages are created with their dependencies and their
recommended package dependencies listed: <filename>task-custom-apps</filename>, and recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and
<filename>task-custom-tools</filename>. <filename>packagegroup-custom-tools</filename>.
To build an image using these task packages, you need to add To build an image using these packagegroup packages, you need to add
<filename>task-custom-apps</filename> and/or <filename>packagegroup-custom-apps</filename> and/or
<filename>task-custom-tools</filename> to <filename>packagegroup-custom-tools</filename> to
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>.
For other forms of image dependencies see the other areas of this section. For other forms of image dependencies see the other areas of this section.
</para> </para>