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>
This commit is contained in:
parent
57f3951f29
commit
2a0a3d631a
|
@ -468,6 +468,64 @@
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section id='usingpoky-extend-customimage-localconf'>
|
||||||
|
<title>Customizing Images Using <filename>local.conf</filename></title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
While not recommended, it is possible to include or exclude packages in the
|
||||||
|
image by setting variables in the <filename>conf/local.conf</filename> file in
|
||||||
|
the Yocto Project build directory.
|
||||||
|
<note>
|
||||||
|
The best way to add packages to an image is to create a layer that contains
|
||||||
|
recipes to specifically add the packages.
|
||||||
|
Using variables with the <filename>local.conf</filename> to add things
|
||||||
|
to images could result in ordering problems or even leave you with a
|
||||||
|
build system that seemingly adds "random" packages to the image.
|
||||||
|
For example, if you use the same or a copied <filename>local.conf</filename>
|
||||||
|
for another project, you might have forgotten about something you added
|
||||||
|
for a previous project.
|
||||||
|
</note>
|
||||||
|
This section describes some of the ways you could include or exclude packages
|
||||||
|
in the image through use of the <filename>conf/local.conf</filename> file.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<section id='adding-packages'>
|
||||||
|
<title>Adding Packages</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Following are some methods to add packages to the image through the
|
||||||
|
use of variables in the <filename>conf/local.conf</filename>:
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis><filename>IMAGE_INSTALL_append</filename> - </emphasis>
|
||||||
|
Some explanation</para></listitem>
|
||||||
|
<listitem><para><emphasis><filename>POKY_EXTRA_append</filename> - </emphasis>
|
||||||
|
Some explanation</para></listitem>
|
||||||
|
<listitem><para><emphasis><filename>POKY_EXTRA_INSTALL</filename> - </emphasis>
|
||||||
|
Some explanation</para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section id='excluding-packages'>
|
||||||
|
<title>Excluding Packages</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
It is possible to filter or mask out recipe and recipe append files such that
|
||||||
|
BitBake ignores them.
|
||||||
|
You can do this by providing an expression with the
|
||||||
|
<filename>BBMASK</filename> variable.
|
||||||
|
Here is an example:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
BBMASK = ".*/meta-mymachine/recipes-maybe/"
|
||||||
|
</literallayout>
|
||||||
|
Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files
|
||||||
|
in the directory that matches the expression are ignored during the build
|
||||||
|
process.
|
||||||
|
</para>
|
||||||
|
</section>
|
||||||
|
<!--
|
||||||
|
THIS IS THE ORIGINAL STUFF
|
||||||
|
|
||||||
<section id='usingpoky-extend-customimage-localconf'>
|
<section id='usingpoky-extend-customimage-localconf'>
|
||||||
<title>Customizing Images Using <filename>local.conf</filename></title>
|
<title>Customizing Images Using <filename>local.conf</filename></title>
|
||||||
|
|
||||||
|
@ -489,9 +547,8 @@
|
||||||
<para>
|
<para>
|
||||||
However, since the
|
However, since the
|
||||||
<filename><link linkend='var-DISTRO_EXTRA_RDEPENDS'>DISTRO_EXTRA_RDEPENDS</link></filename>
|
<filename><link linkend='var-DISTRO_EXTRA_RDEPENDS'>DISTRO_EXTRA_RDEPENDS</link></filename>
|
||||||
variable is for
|
variable is for distribution maintainers, adding packages using this method is not
|
||||||
distribution maintainers, adding packages using this method is not as simple as adding
|
as simple as adding them using a custom <filename>.bb</filename> file.
|
||||||
them using a custom <filename>.bb</filename> file.
|
|
||||||
Using the <filename>local.conf</filename> file method could result in some packages
|
Using the <filename>local.conf</filename> file method could result in some packages
|
||||||
needing to be recreated.
|
needing to be recreated.
|
||||||
For example, if packages were previously created and the image was rebuilt, then the packages
|
For example, if packages were previously created and the image was rebuilt, then the packages
|
||||||
|
@ -512,6 +569,7 @@
|
||||||
$ bitbake core-image-sato
|
$ bitbake core-image-sato
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
|
</section> -->
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue