mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-03 01:40:07 +00:00
Code Issues Projects Releases Wiki Activity

sphinx: import docs

Browse Source 
The Yocto Project docs was migrated from Docbook to Sphinx in YP
 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
 the docs in 3.2, we agreed to backport sphinx docs onto 3.1.

This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx

There are other changes after this commit, but they will be
 selectively backported in individual patches.

This patch was generated with the following command:

git cherry-pick -n \
 $(git log --reverse --oneline \
 ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')

The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.

069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release

(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Nicolas Dechesne
2020-11-20 20:17:33 +01:00
committed by Richard Purdie
parent a038e58f3c
commit fa0cb4d34b
212 changed files with 59939 additions and 371 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/examples/hello-autotools/hello_2.10.bb
+9
View File
@@ -0,0 +1,9 @@
DESCRIPTION = "GNU Helloworld application"
SECTION = "examples"
LICENSE = "GPLv3"
LIC_FILES_CHKSUM = "file://COPYING;md5=d32239bcb673463ab874e80d47fae504"
SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"
SRC_URI[sha256sum] = "31e066137a962676e89f69d1b65382de95a7ef7d914b8cb956f41ea72e0f516b"
inherit autotools-brokensep gettext
documentation/ref-manual/examples/hello-autotools/hello_2.3.bb
-8
View File
@@ -1,8 +0,0 @@
DESCRIPTION = "GNU Helloworld application"
SECTION = "examples"
LICENSE = "GPLv3"
LIC_FILES_CHKSUM = "file://COPYING;md5=adefda309052235aa5d1e99ce7557010"
SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.bz2"
inherit autotools
documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
+1 -1
View File
@@ -1,4 +1,4 @@
require xorg-lib-common.inc
require recipes-graphics/xorg-lib/xorg-lib-common.inc
DESCRIPTION = "X11 Pixmap library"
LICENSE = "X-BSD"
documentation/ref-manual/faq.rst
+451
View File
@@ -0,0 +1,451 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
***
FAQ
***
**Q:** How does Poky differ from `OpenEmbedded <http://www.openembedded.org/>`__?
**A:** The term ``Poky`` refers to the specific reference build
system that the Yocto Project provides. Poky is based on
:term:`OpenEmbedded-Core (OE-Core)` and :term:`BitBake`. Thus, the
generic term used here for the build system is the "OpenEmbedded build
system." Development in the Yocto Project using Poky is closely tied to
OpenEmbedded, with changes always being merged to OE-Core or BitBake
first before being pulled back into Poky. This practice benefits both
projects immediately.
**Q:** My development system does not meet the required Git, tar, and
Python versions. In particular, I do not have Python 3.5.0 or greater.
Can I still use the Yocto Project?
**A:** You can get the required tools on your host development system a
couple different ways (i.e. building a tarball or downloading a
tarball). See the "`Required Git, tar, Python and gcc
Versions <#required-git-tar-python-and-gcc-versions>`__" section for
steps on how to update your build tools.
**Q:** How can you claim Poky / OpenEmbedded-Core is stable?
**A:** There are three areas that help with stability;
- The Yocto Project team keeps :term:`OpenEmbedded-Core (OE-Core)` small and
focused, containing around 830 recipes as opposed to the thousands
available in other OpenEmbedded community layers. Keeping it small
makes it easy to test and maintain.
- The Yocto Project team runs manual and automated tests using a small,
fixed set of reference hardware as well as emulated targets.
- The Yocto Project uses an autobuilder, which provides continuous
build and integration tests.
**Q:** How do I get support for my board added to the Yocto Project?
**A:** Support for an additional board is added by creating a Board
Support Package (BSP) layer for it. For more information on how to
create a BSP layer, see the
":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
section in the Yocto Project Development Tasks Manual and the
:doc:`../bsp-guide/bsp-guide`.
Usually, if the board is not completely exotic, adding support in the
Yocto Project is fairly straightforward.
**Q:** Are there any products built using the OpenEmbedded build system?
**A:** The software running on the `Vernier
LabQuest <http://vernier.com/labquest/>`__ is built using the
OpenEmbedded build system. See the `Vernier
LabQuest <http://www.vernier.com/products/interfaces/labq/>`__ website
for more information. There are a number of pre-production devices using
the OpenEmbedded build system and the Yocto Project team announces them
as soon as they are released.
**Q:** What does the OpenEmbedded build system produce as output?
**A:** Because you can use the same set of recipes to create output of
various formats, the output of an OpenEmbedded build depends on how you
start it. Usually, the output is a flashable image ready for the target
device.
**Q:** How do I add my package to the Yocto Project?
**A:** To add a package, you need to create a BitBake recipe. For
information on how to create a BitBake recipe, see the
":ref:`dev-manual/dev-manual-common-tasks:writing a new recipe`"
section in the Yocto Project Development Tasks Manual.
**Q:** Do I have to reflash my entire board with a new Yocto Project
image when recompiling a package?
**A:** The OpenEmbedded build system can build packages in various
formats such as IPK for OPKG, Debian package (``.deb``), or RPM. You can
then upgrade the packages using the package tools on the device, much
like on a desktop distribution such as Ubuntu or Fedora. However,
package management on the target is entirely optional.
**Q:** I see the error
'``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``'. What is
wrong?
**A:** You are probably running the build on an NTFS filesystem. Use
``ext2``, ``ext3``, or ``ext4`` instead.
**Q:** I see lots of 404 responses for files when the OpenEmbedded build
system is trying to download sources. Is something wrong?
**A:** Nothing is wrong. The OpenEmbedded build system checks any
configured source mirrors before downloading from the upstream sources.
The build system does this searching for both source archives and
pre-checked out versions of SCM-managed software. These checks help in
large installations because it can reduce load on the SCM servers
themselves. The address above is one of the default mirrors configured
into the build system. Consequently, if an upstream source disappears,
the team can place sources there so builds continue to work.
**Q:** I have machine-specific data in a package for one machine only
but the package is being marked as machine-specific in all cases, how do
I prevent this?
**A:** Set ``SRC_URI_OVERRIDES_PACKAGE_ARCH`` = "0" in the ``.bb`` file
but make sure the package is manually marked as machine-specific for the
case that needs it. The code that handles
``SRC_URI_OVERRIDES_PACKAGE_ARCH`` is in the
``meta/classes/base.bbclass`` file.
**Q:** I'm behind a firewall and need to use a proxy server. How do I do
that?
**A:** Most source fetching by the OpenEmbedded build system is done by
``wget`` and you therefore need to specify the proxy settings in a
``.wgetrc`` file, which can be in your home directory if you are a
single user or can be in ``/usr/local/etc/wgetrc`` as a global user
file.
Following is the applicable code for setting various proxy types in the
``.wgetrc`` file. By default, these settings are disabled with comments.
To use them, remove the comments: ::
# You can set the default proxies for Wget to use for http, https, and ftp.
# They will override the value in the environment.
#https_proxy = http://proxy.yoyodyne.com:18023/
#http_proxy = http://proxy.yoyodyne.com:18023/
#ftp_proxy = http://proxy.yoyodyne.com:18023/
# If you do not want to use proxy at all, set this to off.
#use_proxy = on
The Yocto Project also includes a
``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS
and Git proxy servers if needed. For more information on setting up
various proxy types and configuring proxy servers, see the
":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
Wiki page.
**Q:** What's the difference between target and target\ ``-native``?
**A:** The ``*-native`` targets are designed to run on the system being
used for the build. These are usually tools that are needed to assist
the build in some way such as ``quilt-native``, which is used to apply
patches. The non-native version is the one that runs on the target
device.
**Q:** I'm seeing random build failures. Help?!
**A:** If the same build is failing in totally different and random
ways, the most likely explanation is:
- The hardware you are running the build on has some problem.
- You are running the build under virtualization, in which case the
virtualization probably has bugs.
The OpenEmbedded build system processes a massive amount of data that
causes lots of network, disk and CPU activity and is sensitive to even
single-bit failures in any of these areas. True random failures have
always been traced back to hardware or virtualization issues.
**Q:** When I try to build a native recipe, the build fails with
``iconv.h`` problems.
**A:** If you get an error message that indicates GNU ``libiconv`` is
not in use but ``iconv.h`` has been included from ``libiconv``, you need
to check to see if you have a previously installed version of the header
file in ``/usr/local/include``.
::
#error GNU libiconv not in use but included iconv.h is from libiconv
If you find a previously installed
file, you should either uninstall it or temporarily rename it and try
the build again.
This issue is just a single manifestation of "system leakage" issues
caused when the OpenEmbedded build system finds and uses previously
installed files during a native build. This type of issue might not be
limited to ``iconv.h``. Be sure that leakage cannot occur from
``/usr/local/include`` and ``/opt`` locations.
**Q:** What do we need to ship for license compliance?
**A:** This is a difficult question and you need to consult your lawyer
for the answer for your specific case. It is worth bearing in mind that
for GPL compliance, there needs to be enough information shipped to
allow someone else to rebuild and produce the same end result you are
shipping. This means sharing the source code, any patches applied to it,
and also any configuration information about how that package was
configured and built.
You can find more information on licensing in the
":ref:`overview-manual/overview-manual-development-environment:licensing`"
section in the Yocto
Project Overview and Concepts Manual and also in the
":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`"
section in the Yocto Project Development Tasks Manual.
**Q:** How do I disable the cursor on my touchscreen device?
**A:** You need to create a form factor file as described in the
":ref:`bsp-filelayout-misc-recipes`" section in
the Yocto Project Board Support Packages (BSP) Developer's Guide. Set
the ``HAVE_TOUCHSCREEN`` variable equal to one as follows:
::
HAVE_TOUCHSCREEN=1
**Q:** How do I make sure connected network interfaces are brought up by
default?
**A:** The default interfaces file provided by the netbase recipe does
not automatically bring up network interfaces. Therefore, you will need
to add a BSP-specific netbase that includes an interfaces file. See the
":ref:`bsp-filelayout-misc-recipes`" section in
the Yocto Project Board Support Packages (BSP) Developer's Guide for
information on creating these types of miscellaneous recipe files.
For example, add the following files to your layer: ::
meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces
meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend
**Q:** How do I create images with more free space?
**A:** By default, the OpenEmbedded build system creates images that are
1.3 times the size of the populated root filesystem. To affect the image
size, you need to set various configurations:
- *Image Size:* The OpenEmbedded build system uses the
:term:`IMAGE_ROOTFS_SIZE` variable to define
the size of the image in Kbytes. The build system determines the size
by taking into account the initial root filesystem size before any
modifications such as requested size for the image and any requested
additional free disk space to be added to the image.
- *Overhead:* Use the
:term:`IMAGE_OVERHEAD_FACTOR` variable
to define the multiplier that the build system applies to the initial
image size, which is 1.3 by default.
- *Additional Free Space:* Use the
:term:`IMAGE_ROOTFS_EXTRA_SPACE`
variable to add additional free space to the image. The build system
adds this space to the image after it determines its
``IMAGE_ROOTFS_SIZE``.
**Q:** Why don't you support directories with spaces in the pathnames?
**A:** The Yocto Project team has tried to do this before but too many
of the tools the OpenEmbedded build system depends on, such as
``autoconf``, break when they find spaces in pathnames. Until that
situation changes, the team will not support spaces in pathnames.
**Q:** How do I use an external toolchain?
**A:** The toolchain configuration is very flexible and customizable. It
is primarily controlled with the ``TCMODE`` variable. This variable
controls which ``tcmode-*.inc`` file to include from the
``meta/conf/distro/include`` directory within the :term:`Source Directory`.
The default value of ``TCMODE`` is "default", which tells the
OpenEmbedded build system to use its internally built toolchain (i.e.
``tcmode-default.inc``). However, other patterns are accepted. In
particular, "external-\*" refers to external toolchains. One example is
the Sourcery G++ Toolchain. The support for this toolchain resides in
the separate ``meta-sourcery`` layer at
http://github.com/MentorEmbedded/meta-sourcery/.
In addition to the toolchain configuration, you also need a
corresponding toolchain recipe file. This recipe file needs to package
up any pre-built objects in the toolchain such as ``libgcc``,
``libstdcc++``, any locales, and ``libc``.
**Q:** How does the OpenEmbedded build system obtain source code and
will it work behind my firewall or proxy server?
**A:** The way the build system obtains source code is highly
configurable. You can setup the build system to get source code in most
environments if HTTP transport is available.
When the build system searches for source code, it first tries the local
download directory. If that location fails, Poky tries
:term:`PREMIRRORS`, the upstream source, and then
:term:`MIRRORS` in that order.
Assuming your distribution is "poky", the OpenEmbedded build system uses
the Yocto Project source ``PREMIRRORS`` by default for SCM-based
sources, upstreams for normal tarballs, and then falls back to a number
of other mirrors including the Yocto Project source mirror if those
fail.
As an example, you could add a specific server for the build system to
attempt before any others by adding something like the following to the
``local.conf`` configuration file: ::
PREMIRRORS_prepend = "\
git://.*/.* http://www.yoctoproject.org/sources/ \n \
ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
http://.*/.* http://www.yoctoproject.org/sources/ \n \
https://.*/.* http://www.yoctoproject.org/sources/ \n"
These changes cause the build system to intercept Git, FTP, HTTP, and
HTTPS requests and direct them to the ``http://`` sources mirror. You
can use ``file://`` URLs to point to local directories or network shares
as well.
Aside from the previous technique, these options also exist:
::
BB_NO_NETWORK = "1"
This statement tells BitBake to issue an error
instead of trying to access the Internet. This technique is useful if
you want to ensure code builds only from local sources.
Here is another technique:
::
BB_FETCH_PREMIRRORONLY = "1"
This statement
limits the build system to pulling source from the ``PREMIRRORS`` only.
Again, this technique is useful for reproducing builds.
Here is another technique:
::
BB_GENERATE_MIRROR_TARBALLS = "1"
This
statement tells the build system to generate mirror tarballs. This
technique is useful if you want to create a mirror server. If not,
however, the technique can simply waste time during the build.
Finally, consider an example where you are behind an HTTP-only firewall.
You could make the following changes to the ``local.conf`` configuration
file as long as the ``PREMIRRORS`` server is current: ::
PREMIRRORS_prepend = "\
ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
http://.*/.* http://www.yoctoproject.org/sources/ \n \
https://.*/.* http://www.yoctoproject.org/sources/ \n"
BB_FETCH_PREMIRRORONLY = "1"
These changes would cause the build system to successfully fetch source
over HTTP and any network accesses to anything other than the
``PREMIRRORS`` would fail.
The build system also honors the standard shell environment variables
``http_proxy``, ``ftp_proxy``, ``https_proxy``, and ``all_proxy`` to
redirect requests through proxy servers.
.. note::
You can find more information on the
":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
Wiki page.
**Q:** Can I get rid of build output so I can start over?
**A:** Yes - you can easily do this. When you use BitBake to build an
image, all the build output goes into the directory created when you run
the build environment setup script (i.e.
````` <#structure-core-script>`__). By default, this :term:`Build Directory`
is named ``build`` but can be named
anything you want.
Within the Build Directory, is the ``tmp`` directory. To remove all the
build output yet preserve any source code or downloaded files from
previous builds, simply remove the ``tmp`` directory.
**Q:** Why do ``${bindir}`` and ``${libdir}`` have strange values for
``-native`` recipes?
**A:** Executables and libraries might need to be used from a directory
other than the directory into which they were initially installed.
Complicating this situation is the fact that sometimes these executables
and libraries are compiled with the expectation of being run from that
initial installation target directory. If this is the case, moving them
causes problems.
This scenario is a fundamental problem for package maintainers of
mainstream Linux distributions as well as for the OpenEmbedded build
system. As such, a well-established solution exists. Makefiles,
Autotools configuration scripts, and other build systems are expected to
respect environment variables such as ``bindir``, ``libdir``, and
``sysconfdir`` that indicate where executables, libraries, and data
reside when a program is actually run. They are also expected to respect
a ``DESTDIR`` environment variable, which is prepended to all the other
variables when the build system actually installs the files. It is
understood that the program does not actually run from within
``DESTDIR``.
When the OpenEmbedded build system uses a recipe to build a
target-architecture program (i.e. one that is intended for inclusion on
the image being built), that program eventually runs from the root file
system of that image. Thus, the build system provides a value of
"/usr/bin" for ``bindir``, a value of "/usr/lib" for ``libdir``, and so
forth.
Meanwhile, ``DESTDIR`` is a path within the :term:`Build Directory`.
However, when the recipe builds a
native program (i.e. one that is intended to run on the build machine),
that program is never installed directly to the build machine's root
file system. Consequently, the build system uses paths within the Build
Directory for ``DESTDIR``, ``bindir`` and related variables. To better
understand this, consider the following two paths where the first is
relatively normal and the second is not: ::
/home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/
1.2.8-r0/sysroot-destdir/usr/bin
/home/maxtothemax/poky-bootchart2/build/tmp/work/x86_64-linux/
zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/
build/tmp/sysroots/x86_64-linux/usr/bin
.. note::
Due to these lengthy examples, the paths are artificially broken
across lines for readability.
Even if the paths look unusual,
they both are correct - the first for a target and the second for a
native recipe. These paths are a consequence of the ``DESTDIR``
mechanism and while they appear strange, they are correct and in
practice very effective.
**Q:** The files provided by my ``*-native`` recipe do not appear to be
available to other recipes. Files are missing from the native sysroot,
my recipe is installing to the wrong place, or I am getting permissions
errors during the do_install task in my recipe! What is wrong?
**A:** This situation results when a build system does not recognize the
environment variables supplied to it by :term:`BitBake`. The
incident that prompted this FAQ entry involved a Makefile that used an
environment variable named ``BINDIR`` instead of the more standard
variable ``bindir``. The makefile's hardcoded default value of
"/usr/bin" worked most of the time, but not for the recipe's ``-native``
variant. For another example, permissions errors might be caused by a
Makefile that ignores ``DESTDIR`` or uses a different name for that
environment variable. Check the the build system to see if these kinds
of issues exist.
documentation/ref-manual/faq.xml
+2 -1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='faq'>
<title>FAQ</title>
@@ -322,7 +323,7 @@
<qandaentry>
<question>
<para>
What’s the difference between <replaceable>target</replaceable> and <replaceable>target</replaceable><filename>-native</filename>?
What's the difference between <replaceable>target</replaceable> and <replaceable>target</replaceable><filename>-native</filename>?
</para>
</question>
<answer>
documentation/ref-manual/history.rst
+74
View File
@@ -0,0 +1,74 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
***********************
Manual Revision History
***********************
.. list-table::
:widths: 10 15 40
:header-rows: 1
* - Revision
- Date
- Note
* - 0.9
- November 2010
- The initial document released with the Yocto Project 0.9 Release
* - 1.0
- April 2011
- Released with the Yocto Project 1.0 Release.
* - 1.1
- October 2011
- Released with the Yocto Project 1.1 Release.
* - 1.2
- April 2012
- Released with the Yocto Project 1.2 Release.
* - 1.3
- October 2012
- Released with the Yocto Project 1.3 Release.
* - 1.4
- April 2013
- Released with the Yocto Project 1.4 Release.
* - 1.5
- October 2013
- Released with the Yocto Project 1.5 Release.
* - 1.6
- April 2014
- Released with the Yocto Project 1.6 Release.
* - 1.7
- October 2014
- Released with the Yocto Project 1.7 Release.
* - 1.8
- April 2015
- Released with the Yocto Project 1.8 Release.
* - 2.0
- October 2015
- Released with the Yocto Project 2.0 Release.
* - 2.1
- April 2016
- Released with the Yocto Project 2.1 Release.
* - 2.2
- October 2016
- Released with the Yocto Project 2.2 Release.
* - 2.3
- May 2017
- Released with the Yocto Project 2.3 Release.
* - 2.4
- October 2017
- Released with the Yocto Project 2.4 Release.
* - 2.5
- May 2018
- Released with the Yocto Project 2.5 Release.
* - 2.6
- November 2018
- Released with the Yocto Project 2.6 Release.
* - 2.7
- May 2019
- Released with the Yocto Project 2.7 Release.
* - 3.0
- October 2019
- Released with the Yocto Project 3.0 Release.
* - 3.1
- April 2020
- Released with the Yocto Project 3.1 Release.
documentation/ref-manual/migration-1.3.rst
+195
View File
@@ -0,0 +1,195 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
Moving to the Yocto Project 1.3 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.3 Release from the prior release.
.. _1.3-local-configuration:
Local Configuration
-------------------
Differences include changes for
:term:`SSTATE_MIRRORS` and ``bblayers.conf``.
.. _migration-1.3-sstate-mirrors:
SSTATE_MIRRORS
~~~~~~~~~~~~~~
The shared state cache (sstate-cache), as pointed to by
:term:`SSTATE_DIR`, by default now has two-character
subdirectories to prevent issues arising from too many files in the same
directory. Also, native sstate-cache packages, which are built to run on
the host system, will go into a subdirectory named using the distro ID
string. If you copy the newly structured sstate-cache to a mirror
location (either local or remote) and then point to it in
:term:`SSTATE_MIRRORS`, you need to append "PATH"
to the end of the mirror URL so that the path used by BitBake before the
mirror substitution is appended to the path used to access the mirror.
Here is an example: ::
SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH"
.. _migration-1.3-bblayers-conf:
bblayers.conf
~~~~~~~~~~~~~
The ``meta-yocto`` layer consists of two parts that correspond to the
Poky reference distribution and the reference hardware Board Support
Packages (BSPs), respectively: ``meta-yocto`` and ``meta-yocto-bsp``.
When running BitBake for the first time after upgrading, your
``conf/bblayers.conf`` file will be updated to handle this change and
you will be asked to re-run or restart for the changes to take effect.
.. _1.3-recipes:
Recipes
-------
Differences include changes for the following:
.. _migration-1.3-python-function-whitespace:
Python Function Whitespace
~~~~~~~~~~~~~~~~~~~~~~~~~~
All Python functions must now use four spaces for indentation.
Previously, an inconsistent mix of spaces and tabs existed, which made
extending these functions using ``_append`` or ``_prepend`` complicated
given that Python treats whitespace as syntactically significant. If you
are defining or extending any Python functions (e.g.
``populate_packages``, ``do_unpack``, ``do_patch`` and so forth) in
custom recipes or classes, you need to ensure you are using consistent
four-space indentation.
.. _migration-1.3-proto=-in-src-uri:
proto= in SRC_URI
~~~~~~~~~~~~~~~~~
Any use of ``proto=`` in :term:`SRC_URI` needs to be
changed to ``protocol=``. In particular, this applies to the following
URIs:
- ``svn://``
- ``bzr://``
- ``hg://``
- ``osc://``
Other URIs were already using ``protocol=``. This change improves
consistency.
.. _migration-1.3-nativesdk:
nativesdk
~~~~~~~~~
The suffix ``nativesdk`` is now implemented as a prefix, which
simplifies a lot of the packaging code for ``nativesdk`` recipes. All
custom ``nativesdk`` recipes, which are relocatable packages that are
native to :term:`SDK_ARCH`, and any references need to
be updated to use ``nativesdk-*`` instead of ``*-nativesdk``.
.. _migration-1.3-task-recipes:
Task Recipes
~~~~~~~~~~~~
"Task" recipes are now known as "Package groups" and have been renamed
from ``task-*.bb`` to ``packagegroup-*.bb``. Existing references to the
previous ``task-*`` names should work in most cases as there is an
automatic upgrade path for most packages. However, you should update
references in your own recipes and configurations as they could be
removed in future releases. You should also rename any custom ``task-*``
recipes to ``packagegroup-*``, and change them to inherit
``packagegroup`` instead of ``task``, as well as taking the opportunity
to remove anything now handled by ``packagegroup.bbclass``, such as
providing ``-dev`` and ``-dbg`` packages, setting
:term:`LIC_FILES_CHKSUM`, and so forth. See the
":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section for
further details.
.. _migration-1.3-image-features:
IMAGE_FEATURES
~~~~~~~~~~~~~~
Image recipes that previously included "apps-console-core" in
:term:`IMAGE_FEATURES` should now include "splash"
instead to enable the boot-up splash screen. Retaining
"apps-console-core" will still include the splash screen but generates a
warning. The "apps-x11-core" and "apps-x11-games" ``IMAGE_FEATURES``
features have been removed.
.. _migration-1.3-removed-recipes:
Removed Recipes
~~~~~~~~~~~~~~~
The following recipes have been removed. For most of them, it is
unlikely that you would have any references to them in your own
:term:`Metadata`. However, you should check your metadata
against this list to be sure:
- ``libx11-trim``: Replaced by ``libx11``, which has a negligible
size difference with modern Xorg.
- ``xserver-xorg-lite``: Use ``xserver-xorg``, which has a negligible
size difference when DRI and GLX modules are not installed.
- ``xserver-kdrive``: Effectively unmaintained for many years.
- ``mesa-xlib``: No longer serves any purpose.
- ``galago``: Replaced by telepathy.
- ``gail``: Functionality was integrated into GTK+ 2.13.
- ``eggdbus``: No longer needed.
- ``gcc-*-intermediate``: The build has been restructured to avoid
the need for this step.
- ``libgsmd``: Unmaintained for many years. Functionality now
provided by ``ofono`` instead.
- *contacts, dates, tasks, eds-tools*: Largely unmaintained PIM
application suite. It has been moved to ``meta-gnome`` in
``meta-openembedded``.
In addition to the previously listed changes, the ``meta-demoapps``
directory has also been removed because the recipes in it were not being
maintained and many had become obsolete or broken. Additionally, these
recipes were not parsed in the default configuration. Many of these
recipes are already provided in an updated and maintained form within
the OpenEmbedded community layers such as ``meta-oe`` and
``meta-gnome``. For the remainder, you can now find them in the
``meta-extras`` repository, which is in the
:yocto_git:`Source Repositories <>` at
http://git.yoctoproject.org/cgit/cgit.cgi/meta-extras/.
.. _1.3-linux-kernel-naming:
Linux Kernel Naming
-------------------
The naming scheme for kernel output binaries has been changed to now
include :term:`PE` as part of the filename:
::
KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
Because the ``PE`` variable is not set by default, these binary files
could result with names that include two dash characters. Here is an
example: ::
bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin
documentation/ref-manual/migration-1.4.rst
+237
View File
@@ -0,0 +1,237 @@
Moving to the Yocto Project 1.4 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.4 Release from the prior release.
.. _migration-1.4-bitbake:
BitBake
-------
Differences include the following:
- *Comment Continuation:* If a comment ends with a line continuation
(\) character, then the next line must also be a comment. Any
instance where this is not the case, now triggers a warning. You must
either remove the continuation character, or be sure the next line is
a comment.
- *Package Name Overrides:* The runtime package specific variables
:term:`RDEPENDS`,
:term:`RRECOMMENDS`,
:term:`RSUGGESTS`,
:term:`RPROVIDES`,
:term:`RCONFLICTS`,
:term:`RREPLACES`, :term:`FILES`,
:term:`ALLOW_EMPTY`, and the pre, post, install,
and uninstall script functions ``pkg_preinst``, ``pkg_postinst``,
``pkg_prerm``, and ``pkg_postrm`` should always have a package name
override. For example, use ``RDEPENDS_${PN}`` for the main package
instead of ``RDEPENDS``. BitBake uses more strict checks when it
parses recipes.
.. _migration-1.4-build-behavior:
Build Behavior
--------------
Differences include the following:
- *Shared State Code:* The shared state code has been optimized to
avoid running unnecessary tasks. For example, the following no longer
populates the target sysroot since that is not necessary:
::
$ bitbake -c rootfs some-image
Instead, the system just needs to extract the
output package contents, re-create the packages, and construct the
root filesystem. This change is unlikely to cause any problems unless
you have missing declared dependencies.
- *Scanning Directory Names:* When scanning for files in
:term:`SRC_URI`, the build system now uses
:term:`FILESOVERRIDES` instead of
:term:`OVERRIDES` for the directory names. In
general, the values previously in ``OVERRIDES`` are now in
``FILESOVERRIDES`` as well. However, if you relied upon an additional
value you previously added to ``OVERRIDES``, you might now need to
add it to ``FILESOVERRIDES`` unless you are already adding it through
the :term:`MACHINEOVERRIDES` or
:term:`DISTROOVERRIDES` variables, as
appropriate. For more related changes, see the
"`Variables <#migration-1.4-variables>`__" section.
.. _migration-1.4-proxies-and-fetching-source:
Proxies and Fetching Source
---------------------------
A new ``oe-git-proxy`` script has been added to replace previous methods
of handling proxies and fetching source from Git. See the
``meta-yocto/conf/site.conf.sample`` file for information on how to use
this script.
.. _migration-1.4-custom-interfaces-file-netbase-change:
Custom Interfaces File (netbase change)
---------------------------------------
If you have created your own custom ``etc/network/interfaces`` file by
creating an append file for the ``netbase`` recipe, you now need to
create an append file for the ``init-ifupdown`` recipe instead, which
you can find in the :term:`Source Directory` at
``meta/recipes-core/init-ifupdown``. For information on how to use
append files, see the
":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.4-remote-debugging:
Remote Debugging
----------------
Support for remote debugging with the Eclipse IDE is now separated into
an image feature (``eclipse-debug``) that corresponds to the
``packagegroup-core-eclipse-debug`` package group. Previously, the
debugging feature was included through the ``tools-debug`` image
feature, which corresponds to the ``packagegroup-core-tools-debug``
package group.
.. _migration-1.4-variables:
Variables
---------
The following variables have changed:
- ``SANITY_TESTED_DISTROS``: This variable now uses a distribution
ID, which is composed of the host distributor ID followed by the
release. Previously,
:term:`SANITY_TESTED_DISTROS` was
composed of the description field. For example, "Ubuntu 12.10"
becomes "Ubuntu-12.10". You do not need to worry about this change if
you are not specifically setting this variable, or if you are
specifically setting it to "".
- ``SRC_URI``: The ``${``\ :term:`PN`\ ``}``,
``${``\ :term:`PF`\ ``}``,
``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories
have been dropped from the default value of the
:term:`FILESPATH` variable, which is used as the
search path for finding files referred to in
:term:`SRC_URI`. If you have a recipe that relied upon
these directories, which would be unusual, then you will need to add
the appropriate paths within the recipe or, alternatively, rearrange
the files. The most common locations are still covered by ``${BP}``,
``${BPN}``, and "files", which all remain in the default value of
:term:`FILESPATH`.
.. _migration-target-package-management-with-rpm:
Target Package Management with RPM
----------------------------------
If runtime package management is enabled and the RPM backend is
selected, Smart is now installed for package download, dependency
resolution, and upgrades instead of Zypper. For more information on how
to use Smart, run the following command on the target:
::
smart --help
.. _migration-1.4-recipes-moved:
Recipes Moved
-------------
The following recipes were moved from their previous locations because
they are no longer used by anything in the OpenEmbedded-Core:
- ``clutter-box2d``: Now resides in the ``meta-oe`` layer.
- ``evolution-data-server``: Now resides in the ``meta-gnome`` layer.
- ``gthumb``: Now resides in the ``meta-gnome`` layer.
- ``gtkhtml2``: Now resides in the ``meta-oe`` layer.
- ``gupnp``: Now resides in the ``meta-multimedia`` layer.
- ``gypsy``: Now resides in the ``meta-oe`` layer.
- ``libcanberra``: Now resides in the ``meta-gnome`` layer.
- ``libgdata``: Now resides in the ``meta-gnome`` layer.
- ``libmusicbrainz``: Now resides in the ``meta-multimedia`` layer.
- ``metacity``: Now resides in the ``meta-gnome`` layer.
- ``polkit``: Now resides in the ``meta-oe`` layer.
- ``zeroconf``: Now resides in the ``meta-networking`` layer.
.. _migration-1.4-removals-and-renames:
Removals and Renames
--------------------
The following list shows what has been removed or renamed:
- ``evieext``: Removed because it has been removed from ``xserver``
since 2008.
- *Gtk+ DirectFB:* Removed support because upstream Gtk+ no longer
supports it as of version 2.18.
- ``libxfontcache / xfontcacheproto``: Removed because they were
removed from the Xorg server in 2008.
- ``libxp / libxprintapputil / libxprintutil / printproto``: Removed
because the XPrint server was removed from Xorg in 2008.
- ``libxtrap / xtrapproto``: Removed because their functionality was
broken upstream.
- *linux-yocto 3.0 kernel:* Removed with linux-yocto 3.8 kernel being
added. The linux-yocto 3.2 and linux-yocto 3.4 kernels remain as part
of the release.
- ``lsbsetup``: Removed with functionality now provided by
``lsbtest``.
- ``matchbox-stroke``: Removed because it was never more than a
proof-of-concept.
- ``matchbox-wm-2 / matchbox-theme-sato-2``: Removed because they are
not maintained. However, ``matchbox-wm`` and ``matchbox-theme-sato``
are still provided.
- ``mesa-dri``: Renamed to ``mesa``.
- ``mesa-xlib``: Removed because it was no longer useful.
- ``mutter``: Removed because nothing ever uses it and the recipe is
very old.
- ``orinoco-conf``: Removed because it has become obsolete.
- ``update-modules``: Removed because it is no longer used. The
kernel module ``postinstall`` and ``postrm`` scripts can now do the
same task without the use of this script.
- ``web``: Removed because it is not maintained. Superseded by
``web-webkit``.
- ``xf86bigfontproto``: Removed because upstream it has been disabled
by default since 2007. Nothing uses ``xf86bigfontproto``.
- ``xf86rushproto``: Removed because its dependency in ``xserver``
was spurious and it was removed in 2005.
- ``zypper / libzypp / sat-solver``: Removed and been functionally
replaced with Smart (``python-smartpm``) when RPM packaging is used
and package management is enabled on the target.
documentation/ref-manual/migration-1.5.rst
+355
View File
@@ -0,0 +1,355 @@
Moving to the Yocto Project 1.5 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.5 Release from the prior release.
.. _migration-1.5-host-dependency-changes:
Host Dependency Changes
-----------------------
The OpenEmbedded build system now has some additional requirements on
the host system:
- Python 2.7.3+
- Tar 1.24+
- Git 1.7.8+
- Patched version of Make if you are using 3.82. Most distributions
that provide Make 3.82 use the patched version.
If the Linux distribution you are using on your build host does not
provide packages for these, you can install and use the Buildtools
tarball, which provides an SDK-like environment containing them.
For more information on this requirement, see the "`Required Git, tar,
Python and gcc Versions <#required-git-tar-python-and-gcc-versions>`__"
section.
.. _migration-1.5-atom-pc-bsp:
``atom-pc`` Board Support Package (BSP)
---------------------------------------
The ``atom-pc`` hardware reference BSP has been replaced by a
``genericx86`` BSP. This BSP is not necessarily guaranteed to work on
all x86 hardware, but it will run on a wider range of systems than the
``atom-pc`` did.
.. note::
Additionally, a
genericx86-64
BSP has been added for 64-bit Atom systems.
.. _migration-1.5-bitbake:
BitBake
-------
The following changes have been made that relate to BitBake:
- BitBake now supports a ``_remove`` operator. The addition of this
operator means you will have to rename any items in recipe space
(functions, variables) whose names currently contain ``_remove_`` or
end with ``_remove`` to avoid unexpected behavior.
- BitBake's global method pool has been removed. This method is not
particularly useful and led to clashes between recipes containing
functions that had the same name.
- The "none" server backend has been removed. The "process" server
backend has been serving well as the default for a long time now.
- The ``bitbake-runtask`` script has been removed.
- ``${``\ :term:`P`\ ``}`` and
``${``\ :term:`PF`\ ``}`` are no longer added to
:term:`PROVIDES` by default in ``bitbake.conf``.
These version-specific ``PROVIDES`` items were seldom used.
Attempting to use them could result in two versions being built
simultaneously rather than just one version due to the way BitBake
resolves dependencies.
.. _migration-1.5-qa-warnings:
QA Warnings
-----------
The following changes have been made to the package QA checks:
- If you have customized :term:`ERROR_QA` or
:term:`WARN_QA` values in your configuration, check
that they contain all of the issues that you wish to be reported.
Previous Yocto Project versions contained a bug that meant that any
item not mentioned in ``ERROR_QA`` or ``WARN_QA`` would be treated as
a warning. Consequently, several important items were not already in
the default value of ``WARN_QA``. All of the possible QA checks are
now documented in the ":ref:`insane.bbclass <ref-classes-insane>`"
section.
- An additional QA check has been added to check if
``/usr/share/info/dir`` is being installed. Your recipe should delete
this file within :ref:`ref-tasks-install` if "make
install" is installing it.
- If you are using the buildhistory class, the check for the package
version going backwards is now controlled using a standard QA check.
Thus, if you have customized your ``ERROR_QA`` or ``WARN_QA`` values
and still wish to have this check performed, you should add
"version-going-backwards" to your value for one or the other
variables depending on how you wish it to be handled. See the
documented QA checks in the
":ref:`insane.bbclass <ref-classes-insane>`" section.
.. _migration-1.5-directory-layout-changes:
Directory Layout Changes
------------------------
The following directory changes exist:
- Output SDK installer files are now named to include the image name
and tuning architecture through the :term:`SDK_NAME`
variable.
- Images and related files are now installed into a directory that is
specific to the machine, instead of a parent directory containing
output files for multiple machines. The
:term:`DEPLOY_DIR_IMAGE` variable continues
to point to the directory containing images for the current
:term:`MACHINE` and should be used anywhere there is a
need to refer to this directory. The ``runqemu`` script now uses this
variable to find images and kernel binaries and will use BitBake to
determine the directory. Alternatively, you can set the
``DEPLOY_DIR_IMAGE`` variable in the external environment.
- When buildhistory is enabled, its output is now written under the
:term:`Build Directory` rather than
:term:`TMPDIR`. Doing so makes it easier to delete
``TMPDIR`` and preserve the build history. Additionally, data for
produced SDKs is now split by :term:`IMAGE_NAME`.
- The ``pkgdata`` directory produced as part of the packaging process
has been collapsed into a single machine-specific directory. This
directory is located under ``sysroots`` and uses a machine-specific
name (i.e. ``tmp/sysroots/machine/pkgdata``).
.. _migration-1.5-shortened-git-srcrev-values:
Shortened Git ``SRCREV`` Values
-------------------------------
BitBake will now shorten revisions from Git repositories from the normal
40 characters down to 10 characters within :term:`SRCPV`
for improved usability in path and file names. This change should be
safe within contexts where these revisions are used because the chances
of spatially close collisions is very low. Distant collisions are not a
major issue in the way the values are used.
.. _migration-1.5-image-features:
``IMAGE_FEATURES``
------------------
The following changes have been made that relate to
:term:`IMAGE_FEATURES`:
- The value of ``IMAGE_FEATURES`` is now validated to ensure invalid
feature items are not added. Some users mistakenly add package names
to this variable instead of using
:term:`IMAGE_INSTALL` in order to have the
package added to the image, which does not work. This change is
intended to catch those kinds of situations. Valid ``IMAGE_FEATURES``
are drawn from ``PACKAGE_GROUP`` definitions,
:term:`COMPLEMENTARY_GLOB` and a new
"validitems" varflag on ``IMAGE_FEATURES``. The "validitems" varflag
change allows additional features to be added if they are not
provided using the previous two mechanisms.
- The previously deprecated "apps-console-core" ``IMAGE_FEATURES`` item
is no longer supported. Add "splash" to ``IMAGE_FEATURES`` if you
wish to have the splash screen enabled, since this is all that
apps-console-core was doing.
.. _migration-1.5-run:
``/run``
--------
The ``/run`` directory from the Filesystem Hierarchy Standard 3.0 has
been introduced. You can find some of the implications for this change
`here <http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`__.
The change also means that recipes that install files to ``/var/run``
must be changed. You can find a guide on how to make these changes
`here <https://www.mail-archive.com/openembedded-devel@lists.openembedded.org/msg31649.html>`__.
.. _migration-1.5-removal-of-package-manager-database-within-image-recipes:
Removal of Package Manager Database Within Image Recipes
--------------------------------------------------------
The image ``core-image-minimal`` no longer adds
``remove_packaging_data_files`` to
:term:`ROOTFS_POSTPROCESS_COMMAND`.
This addition is now handled automatically when "package-management" is
not in :term:`IMAGE_FEATURES`. If you have custom
image recipes that make this addition, you should remove the lines, as
they are not needed and might interfere with correct operation of
postinstall scripts.
.. _migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time:
Images Now Rebuild Only on Changes Instead of Every Time
--------------------------------------------------------
The :ref:`ref-tasks-rootfs` and other related image
construction tasks are no longer marked as "nostamp". Consequently, they
will only be re-executed when their inputs have changed. Previous
versions of the OpenEmbedded build system always rebuilt the image when
requested rather when necessary.
.. _migration-1.5-task-recipes:
Task Recipes
------------
The previously deprecated ``task.bbclass`` has now been dropped. For
recipes that previously inherited from this class, you should rename
them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup
instead.
For more information, see the
":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section.
.. _migration-1.5-busybox:
BusyBox
-------
By default, we now split BusyBox into two binaries: one that is suid
root for those components that need it, and another for the rest of the
components. Splitting BusyBox allows for optimization that eliminates
the ``tinylogin`` recipe as recommended by upstream. You can disable
this split by setting
:term:`BUSYBOX_SPLIT_SUID` to "0".
.. _migration-1.5-automated-image-testing:
Automated Image Testing
-----------------------
A new automated image testing framework has been added through the
:ref:`testimage.bbclass <ref-classes-testimage*>` class. This
framework replaces the older ``imagetest-qemu`` framework.
You can learn more about performing automated image tests in the
":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.5-build-history:
Build History
-------------
Following are changes to Build History:
- Installed package sizes: ``installed-package-sizes.txt`` for an image
now records the size of the files installed by each package instead
of the size of each compressed package archive file.
- The dependency graphs (``depends*.dot``) now use the actual package
names instead of replacing dashes, dots and plus signs with
underscores.
- The ``buildhistory-diff`` and ``buildhistory-collect-srcrevs``
utilities have improved command-line handling. Use the ``--help``
option for each utility for more information on the new syntax.
For more information on Build History, see the
":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.5-udev:
``udev``
--------
Following are changes to ``udev``:
- ``udev`` no longer brings in ``udev-extraconf`` automatically through
:term:`RRECOMMENDS`, since this was originally
intended to be optional. If you need the extra rules, then add
``udev-extraconf`` to your image.
- ``udev`` no longer brings in ``pciutils-ids`` or ``usbutils-ids``
through ``RRECOMMENDS``. These are not needed by ``udev`` itself and
removing them saves around 350KB.
.. _migration-1.5-removed-renamed-recipes:
Removed and Renamed Recipes
---------------------------
- The ``linux-yocto`` 3.2 kernel has been removed.
- ``libtool-nativesdk`` has been renamed to ``nativesdk-libtool``.
- ``tinylogin`` has been removed. It has been replaced by a suid
portion of Busybox. See the "`BusyBox <#migration-1.5-busybox>`__"
section for more information.
- ``external-python-tarball`` has been renamed to
``buildtools-tarball``.
- ``web-webkit`` has been removed. It has been functionally replaced by
``midori``.
- ``imake`` has been removed. It is no longer needed by any other
recipe.
- ``transfig-native`` has been removed. It is no longer needed by any
other recipe.
- ``anjuta-remote-run`` has been removed. Anjuta IDE integration has
not been officially supported for several releases.
.. _migration-1.5-other-changes:
Other Changes
-------------
Following is a list of short entries describing other changes:
- ``run-postinsts``: Make this generic.
- ``base-files``: Remove the unnecessary ``media/``\ xxx directories.
- ``alsa-state``: Provide an empty ``asound.conf`` by default.
- ``classes/image``: Ensure
:term:`BAD_RECOMMENDATIONS` supports
pre-renamed package names.
- ``classes/rootfs_rpm``: Implement ``BAD_RECOMMENDATIONS`` for RPM.
- ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in
:term:`DISTRO_FEATURES`.
- ``systemd``: Remove ``init.d`` dir if ``systemd`` unit file is
present and ``sysvinit`` is not a distro feature.
- ``libpam``: Deny all services for the ``OTHER`` entries.
- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict
with ``multilib``. See
`YOCTO #4993 <https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993>`_
in Bugzilla for more information.
- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files.
- ``kern-tools``: Switch from guilt to new ``kgit-s2q`` tool.
documentation/ref-manual/migration-1.6.rst
+417
View File
@@ -0,0 +1,417 @@
Moving to the Yocto Project 1.6 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.6 Release from the prior release.
.. _migration-1.6-archiver-class:
``archiver`` Class
------------------
The :ref:`archiver <ref-classes-archiver>` class has been rewritten
and its configuration has been simplified. For more details on the
source archiver, see the
":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.6-packaging-changes:
Packaging Changes
-----------------
The following packaging changes have been made:
- The ``binutils`` recipe no longer produces a ``binutils-symlinks``
package. ``update-alternatives`` is now used to handle the preferred
``binutils`` variant on the target instead.
- The tc (traffic control) utilities have been split out of the main
``iproute2`` package and put into the ``iproute2-tc`` package.
- The ``gtk-engines`` schemas have been moved to a dedicated
``gtk-engines-schemas`` package.
- The ``armv7a`` with thumb package architecture suffix has changed.
The suffix for these packages with the thumb optimization enabled is
"t2" as it should be. Use of this suffix was not the case in the 1.5
release. Architecture names will change within package feeds as a
result.
.. _migration-1.6-bitbake:
BitBake
-------
The following changes have been made to :term:`BitBake`.
.. _migration-1.6-matching-branch-requirement-for-git-fetching:
Matching Branch Requirement for Git Fetching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When fetching source from a Git repository using
:term:`SRC_URI`, BitBake will now validate the
:term:`SRCREV` value against the branch. You can specify
the branch using the following form: SRC_URI =
"git://server.name/repository;branch=branchname" If you do not specify a
branch, BitBake looks in the default "master" branch.
Alternatively, if you need to bypass this check (e.g. if you are
fetching a revision corresponding to a tag that is not on any branch),
you can add ";nobranch=1" to the end of the URL within ``SRC_URI``.
.. _migration-1.6-bitbake-deps:
Python Definition substitutions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
BitBake had some previously deprecated Python definitions within its
``bb`` module removed. You should use their sub-module counterparts
instead:
- ``bb.MalformedUrl``: Use ``bb.fetch.MalformedUrl``.
- ``bb.encodeurl``: Use ``bb.fetch.encodeurl``.
- ``bb.decodeurl``: Use ``bb.fetch.decodeurl``
- ``bb.mkdirhier``: Use ``bb.utils.mkdirhier``.
- ``bb.movefile``: Use ``bb.utils.movefile``.
- ``bb.copyfile``: Use ``bb.utils.copyfile``.
- ``bb.which``: Use ``bb.utils.which``.
- ``bb.vercmp_string``: Use ``bb.utils.vercmp_string``.
- ``bb.vercmp``: Use ``bb.utils.vercmp``.
.. _migration-1.6-bitbake-fetcher:
SVK Fetcher
~~~~~~~~~~~
The SVK fetcher has been removed from BitBake.
.. _migration-1.6-bitbake-console-output:
Console Output Error Redirection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The BitBake console UI will now output errors to ``stderr`` instead of
``stdout``. Consequently, if you are piping or redirecting the output of
``bitbake`` to somewhere else, and you wish to retain the errors, you
will need to add ``2>&1`` (or something similar) to the end of your
``bitbake`` command line.
.. _migration-1.6-task-taskname-overrides:
``task-``\ taskname Overrides
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``task-``\ taskname overrides have been adjusted so that tasks whose
names contain underscores have the underscores replaced by hyphens for
the override so that they now function properly. For example, the task
override for :ref:`ref-tasks-populate_sdk` is
``task-populate-sdk``.
.. _migration-1.6-variable-changes:
Changes to Variables
--------------------
The following variables have changed. For information on the
OpenEmbedded build system variables, see the "`Variables
Glossary <#ref-variables-glos>`__" Chapter.
.. _migration-1.6-variable-changes-TMPDIR:
``TMPDIR``
~~~~~~~~~~
:term:`TMPDIR` can no longer be on an NFS mount. NFS does
not offer full POSIX locking and inode consistency and can cause
unexpected issues if used to store ``TMPDIR``.
The check for this occurs on startup. If ``TMPDIR`` is detected on an
NFS mount, an error occurs.
.. _migration-1.6-variable-changes-PRINC:
``PRINC``
~~~~~~~~~
The ``PRINC`` variable has been deprecated and triggers a warning if
detected during a build. For :term:`PR` increments on changes,
use the PR service instead. You can find out more about this service in
the ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.6-variable-changes-IMAGE_TYPES:
``IMAGE_TYPES``
~~~~~~~~~~~~~~~
The "sum.jffs2" option for :term:`IMAGE_TYPES` has
been replaced by the "jffs2.sum" option, which fits the processing
order.
.. _migration-1.6-variable-changes-COPY_LIC_MANIFEST:
``COPY_LIC_MANIFEST``
~~~~~~~~~~~~~~~~~~~~~
The :term:`COPY_LIC_MANIFEST` variable must now
be set to "1" rather than any value in order to enable it.
.. _migration-1.6-variable-changes-COPY_LIC_DIRS:
``COPY_LIC_DIRS``
~~~~~~~~~~~~~~~~~
The :term:`COPY_LIC_DIRS` variable must now be set
to "1" rather than any value in order to enable it.
.. _migration-1.6-variable-changes-PACKAGE_GROUP:
``PACKAGE_GROUP``
~~~~~~~~~~~~~~~~~
The ``PACKAGE_GROUP`` variable has been renamed to
:term:`FEATURE_PACKAGES` to more accurately
reflect its purpose. You can still use ``PACKAGE_GROUP`` but the
OpenEmbedded build system produces a warning message when it encounters
the variable.
.. _migration-1.6-variable-changes-variable-entry-behavior:
Preprocess and Post Process Command Variable Behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following variables now expect a semicolon separated list of
functions to call and not arbitrary shell commands:
- :term:`ROOTFS_PREPROCESS_COMMAND`
- :term:`ROOTFS_POSTPROCESS_COMMAND`
- :term:`SDK_POSTPROCESS_COMMAND`
- :term:`POPULATE_SDK_POST_TARGET_COMMAND`
- :term:`POPULATE_SDK_POST_HOST_COMMAND`
- :term:`IMAGE_POSTPROCESS_COMMAND`
- :term:`IMAGE_PREPROCESS_COMMAND`
- :term:`ROOTFS_POSTUNINSTALL_COMMAND`
- :term:`ROOTFS_POSTINSTALL_COMMAND`
For
migration purposes, you can simply wrap shell commands in a shell
function and then call the function. Here is an example: ::
my_postprocess_function() {
echo "hello" > ${IMAGE_ROOTFS}/hello.txt
}
ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; "
.. _migration-1.6-package-test-ptest:
Package Test (ptest)
--------------------
Package Tests (ptest) are built but not installed by default. For
information on using Package Tests, see the
":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`"
section in the Yocto Project Development Tasks Manual. For information on the
``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`"
section.
.. _migration-1.6-build-changes:
Build Changes
-------------
Separate build and source directories have been enabled by default for
selected recipes where it is known to work (a whitelist) and for all
recipes that inherit the :ref:`cmake <ref-classes-cmake>` class. In
future releases the :ref:`autotools <ref-classes-autotools>` class
will enable a separate build directory by default as well. Recipes
building Autotools-based software that fails to build with a separate
build directory should be changed to inherit from the
:ref:`autotools-brokensep <ref-classes-autotools>` class instead of
the ``autotools`` or ``autotools_stage``\ classes.
.. _migration-1.6-building-qemu-native:
``qemu-native``
---------------
``qemu-native`` now builds without SDL-based graphical output support by
default. The following additional lines are needed in your
``local.conf`` to enable it:
::
PACKAGECONFIG_pn-qemu-native = "sdl"
ASSUME_PROVIDED += "libsdl-native"
.. note::
The default
local.conf
contains these statements. Consequently, if you are building a
headless system and using a default
local.conf
file, you will need comment these two lines out.
.. _migration-1.6-core-image-basic:
``core-image-basic``
--------------------
``core-image-basic`` has been renamed to ``core-image-full-cmdline``.
In addition to ``core-image-basic`` being renamed,
``packagegroup-core-basic`` has been renamed to
``packagegroup-core-full-cmdline`` to match.
.. _migration-1.6-licensing:
Licensing
---------
The top-level ``LICENSE`` file has been changed to better describe the
license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However,
the licensing itself remains unchanged.
Normally, this change would not cause any side-effects. However, some
recipes point to this file within
:term:`LIC_FILES_CHKSUM` (as
``${COREBASE}/LICENSE``) and thus the accompanying checksum must be
changed from 3f40d7994397109285ec7b81fdeb3b58 to
4d92cd373abda3937c2bc47fbc49d690. A better alternative is to have
``LIC_FILES_CHKSUM`` point to a file describing the license that is
distributed with the source that the recipe is building, if possible,
rather than pointing to ``${COREBASE}/LICENSE``.
.. _migration-1.6-cflags-options:
``CFLAGS`` Options
------------------
The "-fpermissive" option has been removed from the default
:term:`CFLAGS` value. You need to take action on
individual recipes that fail when building with this option. You need to
either patch the recipes to fix the issues reported by the compiler, or
you need to add "-fpermissive" to ``CFLAGS`` in the recipes.
.. _migration-1.6-custom-images:
Custom Image Output Types
-------------------------
Custom image output types, as selected using
:term:`IMAGE_FSTYPES`, must declare their
dependencies on other image types (if any) using a new
:term:`IMAGE_TYPEDEP` variable.
.. _migration-1.6-do-package-write-task:
Tasks
-----
The ``do_package_write`` task has been removed. The task is no longer
needed.
.. _migration-1.6-update-alternatives-provider:
``update-alternative`` Provider
-------------------------------
The default ``update-alternatives`` provider has been changed from
``opkg`` to ``opkg-utils``. This change resolves some troublesome
circular dependencies. The runtime package has also been renamed from
``update-alternatives-cworth`` to ``update-alternatives-opkg``.
.. _migration-1.6-virtclass-overrides:
``virtclass`` Overrides
-----------------------
The ``virtclass`` overrides are now deprecated. Use the equivalent class
overrides instead (e.g. ``virtclass-native`` becomes ``class-native``.)
.. _migration-1.6-removed-renamed-recipes:
Removed and Renamed Recipes
---------------------------
The following recipes have been removed:
- ``packagegroup-toolset-native`` - This recipe is largely unused.
- ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been
dropped. Support for the 3.10 and 3.14 kernels have been added with
the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes.
- ``ocf-linux`` - This recipe has been functionally replaced using
``cryptodev-linux``.
- ``genext2fs`` - ``genext2fs`` is no longer used by the build system
and is unmaintained upstream.
- ``js`` - This provided an ancient version of Mozilla's javascript
engine that is no longer needed.
- ``zaurusd`` - The recipe has been moved to the ``meta-handheld``
layer.
- ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe.
- ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``.
- ``external-sourcery-toolchain`` - this recipe is now maintained in
the ``meta-sourcery`` layer.
- ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the
``linux-libc-headers`` by default.
- ``meta-toolchain-gmae`` - This recipe is obsolete.
- ``packagegroup-core-sdk-gmae`` - This recipe is obsolete.
- ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is
obsolete.
.. _migration-1.6-removed-classes:
Removed Classes
---------------
The following classes have become obsolete and have been removed:
- ``module_strip``
- ``pkg_metainfo``
- ``pkg_distribute``
- ``image-empty``
.. _migration-1.6-reference-bsps:
Reference Board Support Packages (BSPs)
---------------------------------------
The following reference BSPs changes occurred:
- The BeagleBoard (``beagleboard``) ARM reference hardware has been
replaced by the BeagleBone (``beaglebone``) hardware.
- The RouterStation Pro (``routerstationpro``) MIPS reference hardware
has been replaced by the EdgeRouter Lite (``edgerouter``) hardware.
The previous reference BSPs for the ``beagleboard`` and
``routerstationpro`` machines are still available in a new
``meta-yocto-bsp-old`` layer in the
:yocto_git:`Source Repositories <>` at
http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/.
documentation/ref-manual/migration-1.7.rst
+225
View File
@@ -0,0 +1,225 @@
Moving to the Yocto Project 1.7 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.7 Release from the prior release.
.. _migration-1.7-changes-to-setting-qemu-packageconfig-options:
Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf``
-------------------------------------------------------------------
The QEMU recipe now uses a number of
:term:`PACKAGECONFIG` options to enable various
optional features. The method used to set defaults for these options
means that existing ``local.conf`` files will need to be be modified to
append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu``
instead of setting it. In other words, to enable graphical output for
QEMU, you should now have these lines in ``local.conf``:
::
PACKAGECONFIG_append_pn-qemu-native = " sdl"
PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl"
.. _migration-1.7-minimum-git-version:
Minimum Git version
-------------------
The minimum :ref:`overview-manual/overview-manual-development-environment:git`
version required on the
build host is now 1.7.8 because the ``--list`` option is now required by
BitBake's Git fetcher. As always, if your host distribution does not
provide a version of Git that meets this requirement, you can use the
``buildtools-tarball`` that does. See the "`Required Git, tar, Python
and gcc Versions <#required-git-tar-python-and-gcc-versions>`__" section
for more information.
.. _migration-1.7-autotools-class-changes:
Autotools Class Changes
-----------------------
The following :ref:`autotools <ref-classes-autotools>` class changes
occurred:
- *A separate build directory is now used by default:* The
``autotools`` class has been changed to use a directory for building
(:term:`B`), which is separate from the source directory
(:term:`S`). This is commonly referred to as ``B != S``, or
an out-of-tree build.
If the software being built is already capable of building in a
directory separate from the source, you do not need to do anything.
However, if the software is not capable of being built in this
manner, you will need to either patch the software so that it can
build separately, or you will need to change the recipe to inherit
the :ref:`autotools-brokensep <ref-classes-autotools>` class
instead of the ``autotools`` or ``autotools_stage`` classes.
- The ``--foreign`` option is no longer passed to ``automake`` when
running ``autoconf``: This option tells ``automake`` that a
particular software package does not follow the GNU standards and
therefore should not be expected to distribute certain files such as
``ChangeLog``, ``AUTHORS``, and so forth. Because the majority of
upstream software packages already tell ``automake`` to enable
foreign mode themselves, the option is mostly superfluous. However,
some recipes will need patches for this change. You can easily make
the change by patching ``configure.ac`` so that it passes "foreign"
to ``AM_INIT_AUTOMAKE()``. See `this
commit <http://cgit.openembedded.org/openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2>`__
for an example showing how to make the patch.
.. _migration-1.7-binary-configuration-scripts-disabled:
Binary Configuration Scripts Disabled
-------------------------------------
Some of the core recipes that package binary configuration scripts now
disable the scripts due to the scripts previously requiring error-prone
path substitution. Software that links against these libraries using
these scripts should use the much more robust ``pkg-config`` instead.
The list of recipes changed in this version (and their configuration
scripts) is as follows:
::
directfb (directfb-config)
freetype (freetype-config)
gpgme (gpgme-config)
libassuan (libassuan-config)
libcroco (croco-6.0-config)
libgcrypt (libgcrypt-config)
libgpg-error (gpg-error-config)
libksba (ksba-config)
libpcap (pcap-config)
libpcre (pcre-config)
libpng (libpng-config, libpng16-config)
libsdl (sdl-config)
libusb-compat (libusb-config)
libxml2 (xml2-config)
libxslt (xslt-config)
ncurses (ncurses-config)
neon (neon-config)
npth (npth-config)
pth (pth-config)
taglib (taglib-config)
Additionally, support for ``pkg-config`` has been added to some recipes in the
previous list in the rare cases where the upstream software package does
not already provide it.
.. _migration-1.7-glibc-replaces-eglibc:
``eglibc 2.19`` Replaced with ``glibc 2.20``
--------------------------------------------
Because ``eglibc`` and ``glibc`` were already fairly close, this
replacement should not require any significant changes to other software
that links to ``eglibc``. However, there were a number of minor changes
in ``glibc 2.20`` upstream that could require patching some software
(e.g. the removal of the ``_BSD_SOURCE`` feature test macro).
``glibc 2.20`` requires version 2.6.32 or greater of the Linux kernel.
Thus, older kernels will no longer be usable in conjunction with it.
For full details on the changes in ``glibc 2.20``, see the upstream
release notes
`here <https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html>`__.
.. _migration-1.7-kernel-module-autoloading:
Kernel Module Autoloading
-------------------------
The :term:`module_autoload_* <module_autoload>` variable is now
deprecated and a new
:term:`KERNEL_MODULE_AUTOLOAD` variable
should be used instead. Also, :term:`module_conf_* <module_conf>`
must now be used in conjunction with a new
:term:`KERNEL_MODULE_PROBECONF` variable.
The new variables no longer require you to specify the module name as
part of the variable name. This change not only simplifies usage but
also allows the values of these variables to be appropriately
incorporated into task signatures and thus trigger the appropriate tasks
to re-execute when changed. You should replace any references to
``module_autoload_*`` with ``KERNEL_MODULE_AUTOLOAD``, and add any
modules for which ``module_conf_*`` is specified to
``KERNEL_MODULE_PROBECONF``.
.. _migration-1.7-qa-check-changes:
QA Check Changes
----------------
The following changes have occurred to the QA check process:
- Additional QA checks ``file-rdeps`` and ``build-deps`` have been
added in order to verify that file dependencies are satisfied (e.g.
package contains a script requiring ``/bin/bash``) and build-time
dependencies are declared, respectively. For more information, please
see the "`QA Error and Warning Messages <#ref-qa-checks>`__" chapter.
- Package QA checks are now performed during a new
:ref:`ref-tasks-package_qa` task rather than being
part of the :ref:`ref-tasks-package` task. This allows
more parallel execution. This change is unlikely to be an issue
except for highly customized recipes that disable packaging tasks
themselves by marking them as ``noexec``. For those packages, you
will need to disable the ``do_package_qa`` task as well.
- Files being overwritten during the
:ref:`ref-tasks-populate_sysroot` task now
trigger an error instead of a warning. Recipes should not be
overwriting files written to the sysroot by other recipes. If you
have these types of recipes, you need to alter them so that they do
not overwrite these files.
You might now receive this error after changes in configuration or
metadata resulting in orphaned files being left in the sysroot. If
you do receive this error, the way to resolve the issue is to delete
your :term:`TMPDIR` or to move it out of the way and
then re-start the build. Anything that has been fully built up to
that point and does not need rebuilding will be restored from the
shared state cache and the rest of the build will be able to proceed
as normal.
.. _migration-1.7-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``x-load``: This recipe has been superseded by U-boot SPL for all
Cortex-based TI SoCs. For legacy boards, the ``meta-ti`` layer, which
contains a maintained recipe, should be used instead.
- ``ubootchart``: This recipe is obsolete. A ``bootchart2`` recipe has
been added to functionally replace it.
- ``linux-yocto 3.4``: Support for the linux-yocto 3.4 kernel has been
dropped. Support for the 3.10 and 3.14 kernels remains, while support
for version 3.17 has been added.
- ``eglibc`` has been removed in favor of ``glibc``. See the
"```eglibc 2.19`` Replaced with
``glibc 2.20`` <#migration-1.7-glibc-replaces-eglibc>`__" section for
more information.
.. _migration-1.7-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous change occurred:
- The build history feature now writes ``build-id.txt`` instead of
``build-id``. Additionally, ``build-id.txt`` now contains the full
build header as printed by BitBake upon starting the build. You
should manually remove old "build-id" files from your existing build
history repositories to avoid confusion. For information on the build
history feature, see the
":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`"
section in the Yocto Project Development Tasks Manual.
documentation/ref-manual/migration-1.8.rst
+183
View File
@@ -0,0 +1,183 @@
Moving to the Yocto Project 1.8 Release
=======================================
This section provides migration information for moving to the Yocto
Project 1.8 Release from the prior release.
.. _migration-1.8-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``owl-video``: Functionality replaced by ``gst-player``.
- ``gaku``: Functionality replaced by ``gst-player``.
- ``gnome-desktop``: This recipe is now available in ``meta-gnome`` and
is no longer needed.
- ``gsettings-desktop-schemas``: This recipe is now available in
``meta-gnome`` and is no longer needed.
- ``python-argparse``: The ``argparse`` module is already provided in
the default Python distribution in a package named
``python-argparse``. Consequently, the separate ``python-argparse``
recipe is no longer needed.
- ``telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control``:
All these recipes have moved to ``meta-oe`` and are consequently no
longer needed by any recipes in OpenEmbedded-Core.
- ``linux-yocto_3.10`` and ``linux-yocto_3.17``: Support for the
linux-yocto 3.10 and 3.17 kernels has been dropped. Support for the
3.14 kernel remains, while support for 3.19 kernel has been added.
- ``poky-feed-config-opkg``: This recipe has become obsolete and is no
longer needed. Use ``distro-feed-config`` from ``meta-oe`` instead.
- ``libav 0.8.x``: ``libav 9.x`` is now used.
- ``sed-native``: No longer needed. A working version of ``sed`` is
expected to be provided by the host distribution.
.. _migration-1.8-bluez:
BlueZ 4.x / 5.x Selection
-------------------------
Proper built-in support for selecting BlueZ 5.x in preference to the
default of 4.x now exists. To use BlueZ 5.x, simply add "bluez5" to your
:term:`DISTRO_FEATURES` value. If you had
previously added append files (``*.bbappend``) to make this selection,
you can now remove them.
Additionally, a ``bluetooth`` class has been added to make selection of
the appropriate bluetooth support within a recipe a little easier. If
you wish to make use of this class in a recipe, add something such as
the following: ::
inherit bluetooth
PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}"
PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4"
PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5"
.. _migration-1.8-kernel-build-changes:
Kernel Build Changes
--------------------
The kernel build process was changed to place the source in a common
shared work area and to place build artifacts separately in the source
code tree. In theory, migration paths have been provided for most common
usages in kernel recipes but this might not work in all cases. In
particular, users need to ensure that ``${S}`` (source files) and
``${B}`` (build artifacts) are used correctly in functions such as
:ref:`ref-tasks-configure` and
:ref:`ref-tasks-install`. For kernel recipes that do not
inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might
wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the
kinds of changes you need to make. For reference, here is the
`commit <http://cgit.openembedded.org/meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>`__
where the ``linux.inc`` file in ``meta-oe`` was updated.
Recipes that rely on the kernel source code and do not inherit the
module classes might need to add explicit dependencies on the
``do_shared_workdir`` kernel task, for example: ::
do_configure[depends] += "virtual/kernel:do_shared_workdir"
.. _migration-1.8-ssl:
SSL 3.0 is Now Disabled in OpenSSL
----------------------------------
SSL 3.0 is now disabled when building OpenSSL. Disabling SSL 3.0 avoids
any lingering instances of the POODLE vulnerability. If you feel you
must re-enable SSL 3.0, then you can add an append file (``*.bbappend``)
for the ``openssl`` recipe to remove "-no-ssl3" from
:term:`EXTRA_OECONF`.
.. _migration-1.8-default-sysroot-poisoning:
Default Sysroot Poisoning
-------------------------
``gcc's`` default sysroot and include directories are now "poisoned". In
other words, the sysroot and include directories are being redirected to
a non-existent location in order to catch when host directories are
being used due to the correct options not being passed. This poisoning
applies both to the cross-compiler used within the build and to the
cross-compiler produced in the SDK.
If this change causes something in the build to fail, it almost
certainly means the various compiler flags and commands are not being
passed correctly to the underlying piece of software. In such cases, you
need to take corrective steps.
.. _migration-1.8-rebuild-improvements:
Rebuild Improvements
--------------------
Changes have been made to the :ref:`base <ref-classes-base>`,
:ref:`autotools <ref-classes-autotools>`, and
:ref:`cmake <ref-classes-cmake>` classes to clean out generated files
when the :ref:`ref-tasks-configure` task needs to be
re-executed.
One of the improvements is to attempt to run "make clean" during the
``do_configure`` task if a ``Makefile`` exists. Some software packages
do not provide a working clean target within their make files. If you
have such recipes, you need to set
:term:`CLEANBROKEN` to "1" within the recipe, for example: ::
CLEANBROKEN = "1"
.. _migration-1.8-qa-check-and-validation-changes:
QA Check and Validation Changes
-------------------------------
The following QA Check and Validation Changes have occurred:
- Usage of ``PRINC`` previously triggered a warning. It now triggers an
error. You should remove any remaining usage of ``PRINC`` in any
recipe or append file.
- An additional QA check has been added to detect usage of ``${D}`` in
:term:`FILES` values where :term:`D` values
should not be used at all. The same check ensures that ``$D`` is used
in ``pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm`` functions
instead of ``${D}``.
- :term:`S` now needs to be set to a valid value within a
recipe. If ``S`` is not set in the recipe, the directory is not
automatically created. If ``S`` does not point to a directory that
exists at the time the :ref:`ref-tasks-unpack` task
finishes, a warning will be shown.
- :term:`LICENSE` is now validated for correct
formatting of multiple licenses. If the format is invalid (e.g.
multiple licenses are specified with no operators to specify how the
multiple licenses interact), then a warning will be shown.
.. _migration-1.8-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes have occurred:
- The ``send-error-report`` script now expects a "-s" option to be
specified before the server address. This assumes a server address is
being specified.
- The ``oe-pkgdata-util`` script now expects a "-p" option to be
specified before the ``pkgdata`` directory, which is now optional. If
the ``pkgdata`` directory is not specified, the script will run
BitBake to query :term:`PKGDATA_DIR` from the
build environment.
documentation/ref-manual/migration-2.0.rst
+281
View File
@@ -0,0 +1,281 @@
Moving to the Yocto Project 2.0 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.0 Release from the prior release.
.. _migration-2.0-gcc-5:
GCC 5
-----
The default compiler is now GCC 5.2. This change has required fixes for
compilation errors in a number of other recipes.
One important example is a fix for when the Linux kernel freezes at boot
time on ARM when built with GCC 5. If you are using your own kernel
recipe or source tree and building for ARM, you will likely need to
apply this
`patch <https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2>`__.
The standard ``linux-yocto`` kernel source tree already has a workaround
for the same issue.
For further details, see https://gcc.gnu.org/gcc-5/changes.html
and the porting guide at
https://gcc.gnu.org/gcc-5/porting_to.html.
Alternatively, you can switch back to GCC 4.9 or 4.8 by setting
``GCCVERSION`` in your configuration, as follows:
::
GCCVERSION = "4.9%"
.. _migration-2.0-Gstreamer-0.10-removed:
Gstreamer 0.10 Removed
----------------------
Gstreamer 0.10 has been removed in favor of Gstreamer 1.x. As part of
the change, recipes for Gstreamer 0.10 and related software are now
located in ``meta-multimedia``. This change results in Qt4 having Phonon
and Gstreamer support in QtWebkit disabled by default.
.. _migration-2.0-removed-recipes:
Removed Recipes
---------------
The following recipes have been moved or removed:
- ``bluez4``: The recipe is obsolete and has been moved due to
``bluez5`` becoming fully integrated. The ``bluez4`` recipe now
resides in ``meta-oe``.
- ``gamin``: The recipe is obsolete and has been removed.
- ``gnome-icon-theme``: The recipe's functionally has been replaced by
``adwaita-icon-theme``.
- Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have been removed
in favor of the recipes for Gstreamer 1.x.
- ``insserv``: The recipe is obsolete and has been removed.
- ``libunique``: The recipe is no longer used and has been moved to
``meta-oe``.
- ``midori``: The recipe's functionally has been replaced by
``epiphany``.
- ``python-gst``: The recipe is obsolete and has been removed since it
only contains bindings for Gstreamer 0.10.
- ``qt-mobility``: The recipe is obsolete and has been removed since it
requires ``Gstreamer 0.10``, which has been replaced.
- ``subversion``: All 1.6.x versions of this recipe have been removed.
- ``webkit-gtk``: The older 1.8.3 version of this recipe has been
removed in favor of ``webkitgtk``.
.. _migration-2.0-bitbake-datastore-improvements:
BitBake datastore improvements
------------------------------
The method by which BitBake's datastore handles overrides has changed.
Overrides are now applied dynamically and ``bb.data.update_data()`` is
now a no-op. Thus, ``bb.data.update_data()`` is no longer required in
order to apply the correct overrides. In practice, this change is
unlikely to require any changes to Metadata. However, these minor
changes in behavior exist:
- All potential overrides are now visible in the variable history as
seen when you run the following:
::
$ bitbake -e
- ``d.delVar('``\ VARNAME\ ``')`` and
``d.setVar('``\ VARNAME\ ``', None)`` result in the variable and all
of its overrides being cleared out. Before the change, only the
non-overridden values were cleared.
.. _migration-2.0-shell-message-function-changes:
Shell Message Function Changes
------------------------------
The shell versions of the BitBake message functions (i.e. ``bbdebug``,
``bbnote``, ``bbwarn``, ``bbplain``, ``bberror``, and ``bbfatal``) are
now connected through to their BitBake equivalents ``bb.debug()``,
``bb.note()``, ``bb.warn()``, ``bb.plain()``, ``bb.error()``, and
``bb.fatal()``, respectively. Thus, those message functions that you
would expect to be printed by the BitBake UI are now actually printed.
In practice, this change means two things:
- If you now see messages on the console that you did not previously
see as a result of this change, you might need to clean up the calls
to ``bbwarn``, ``bberror``, and so forth. Or, you might want to
simply remove the calls.
- The ``bbfatal`` message function now suppresses the full error log in
the UI, which means any calls to ``bbfatal`` where you still wish to
see the full error log should be replaced by ``die`` or
``bbfatal_log``.
.. _migration-2.0-extra-development-debug-package-cleanup:
Extra Development/Debug Package Cleanup
---------------------------------------
The following recipes have had extra ``dev/dbg`` packages removed:
- ``acl``
- ``apmd``
- ``aspell``
- ``attr``
- ``augeas``
- ``bzip2``
- ``cogl``
- ``curl``
- ``elfutils``
- ``gcc-target``
- ``libgcc``
- ``libtool``
- ``libxmu``
- ``opkg``
- ``pciutils``
- ``rpm``
- ``sysfsutils``
- ``tiff``
- ``xz``
All of the above recipes now conform to the standard packaging scheme
where a single ``-dev``, ``-dbg``, and ``-staticdev`` package exists per
recipe.
.. _migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core:
Recipe Maintenance Tracking Data Moved to OE-Core
-------------------------------------------------
Maintenance tracking data for recipes that was previously part of
``meta-yocto`` has been moved to :term:`OpenEmbedded-Core (OE-Core)`. The change
includes ``package_regex.inc`` and ``distro_alias.inc``, which are
typically enabled when using the ``distrodata`` class. Additionally, the
contents of ``upstream_tracking.inc`` has now been split out to the
relevant recipes.
.. _migration-2.0-automatic-stale-sysroot-file-cleanup:
Automatic Stale Sysroot File Cleanup
------------------------------------
Stale files from recipes that no longer exist in the current
configuration are now automatically removed from sysroot as well as
removed from any other place managed by shared state. This automatic
cleanup means that the build system now properly handles situations such
as renaming the build system side of recipes, removal of layers from
``bblayers.conf``, and :term:`DISTRO_FEATURES`
changes.
Additionally, work directories for old versions of recipes are now
pruned. If you wish to disable pruning old work directories, you can set
the following variable in your configuration:
::
SSTATE_PRUNE_OBSOLETEWORKDIR = "0"
.. _migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source:
``linux-yocto`` Kernel Metadata Repository Now Split from Source
----------------------------------------------------------------
The ``linux-yocto`` tree has up to now been a combined set of kernel
changes and configuration (meta) data carried in a single tree. While
this format is effective at keeping kernel configuration and source
modifications synchronized, it is not always obvious to developers how
to manipulate the Metadata as compared to the source.
Metadata processing has now been removed from the
:ref:`kernel-yocto <ref-classes-kernel-yocto>` class and the external
Metadata repository ``yocto-kernel-cache``, which has always been used
to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto``
cache repository is now the primary location for this data. Due to this
change, ``linux-yocto`` is no longer able to process combined trees.
Thus, if you need to have your own combined kernel repository, you must
do the split there as well and update your recipes accordingly. See the
``meta/recipes-kernel/linux/linux-yocto_4.1.bb`` recipe for an example.
.. _migration-2.0-additional-qa-checks:
Additional QA checks
--------------------
The following QA checks have been added:
- Added a "host-user-contaminated" check for ownership issues for
packaged files outside of ``/home``. The check looks for files that
are incorrectly owned by the user that ran BitBake instead of owned
by a valid user in the target system.
- Added an "invalid-chars" check for invalid (non-UTF8) characters in
recipe metadata variable values (i.e.
:term:`DESCRIPTION`,
:term:`SUMMARY`, :term:`LICENSE`, and
:term:`SECTION`). Some package managers do not support
these characters.
- Added an "invalid-packageconfig" check for any options specified in
:term:`PACKAGECONFIG` that do not match any
``PACKAGECONFIG`` option defined for the recipe.
.. _migration-2.0-miscellaneous:
Miscellaneous Changes
---------------------
These additional changes exist:
- ``gtk-update-icon-cache`` has been renamed to ``gtk-icon-utils``.
- The ``tools-profile`` :term:`IMAGE_FEATURES`
item as well as its corresponding packagegroup and
``packagegroup-core-tools-profile`` no longer bring in ``oprofile``.
Bringing in ``oprofile`` was originally added to aid compilation on
resource-constrained targets. However, this aid has not been widely
used and is not likely to be used going forward due to the more
powerful target platforms and the existence of better
cross-compilation tools.
- The :term:`IMAGE_FSTYPES` variable's default
value now specifies ``ext4`` instead of ``ext3``.
- All support for the ``PRINC`` variable has been removed.
- The ``packagegroup-core-full-cmdline`` packagegroup no longer brings
in ``lighttpd`` due to the fact that bringing in ``lighttpd`` is not
really in line with the packagegroup's purpose, which is to add full
versions of command-line tools that by default are provided by
``busybox``.
documentation/ref-manual/migration-2.1.rst
+434
View File
@@ -0,0 +1,434 @@
Moving to the Yocto Project 2.1 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.1 Release from the prior release.
.. _migration-2.1-variable-expansion-in-python-functions:
Variable Expansion in Python Functions
--------------------------------------
Variable expressions, such as ``${``\ VARNAME\ ``}`` no longer expand
automatically within Python functions. Suppressing expansion was done to
allow Python functions to construct shell scripts or other code for
situations in which you do not want such expressions expanded. For any
existing code that relies on these expansions, you need to change the
expansions to expand the value of individual variables through
``d.getVar()``. To alternatively expand more complex expressions, use
``d.expand()``.
.. _migration-2.1-overrides-must-now-be-lower-case:
Overrides Must Now be Lower-Case
--------------------------------
The convention for overrides has always been for them to be lower-case
characters. This practice is now a requirement as BitBake's datastore
now assumes lower-case characters in order to give a slight performance
boost during parsing. In practical terms, this requirement means that
anything that ends up in :term:`OVERRIDES` must now
appear in lower-case characters (e.g. values for ``MACHINE``,
``TARGET_ARCH``, ``DISTRO``, and also recipe names if
``_pn-``\ recipename overrides are to be effective).
.. _migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory:
Expand Parameter to ``getVar()`` and ``getVarFlag()`` is Now Mandatory
----------------------------------------------------------------------
The expand parameter to ``getVar()`` and ``getVarFlag()`` previously
defaulted to False if not specified. Now, however, no default exists so
one must be specified. You must change any ``getVar()`` calls that do
not specify the final expand parameter to calls that do specify the
parameter. You can run the following ``sed`` command at the base of a
layer to make this change:
::
sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *`
sed -e 's:\(\.getVarFlag([^,()]*,[^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *`
.. note::
The reason for this change is that it prepares the way for changing
the default to True in a future Yocto Project release. This future
change is a much more sensible default than False. However, the
change needs to be made gradually as a sudden change of the default
would potentially cause side-effects that would be difficult to
detect.
.. _migration-2.1-makefile-environment-changes:
Makefile Environment Changes
----------------------------
:term:`EXTRA_OEMAKE` now defaults to "" instead of
"-e MAKEFLAGS=". Setting ``EXTRA_OEMAKE`` to "-e MAKEFLAGS=" by default
was a historical accident that has required many classes (e.g.
``autotools``, ``module``) and recipes to override this default in order
to work with sensible build systems. When upgrading to the release, you
must edit any recipe that relies upon this old default by either setting
``EXTRA_OEMAKE`` back to "-e MAKEFLAGS=" or by explicitly setting any
required variable value overrides using ``EXTRA_OEMAKE``, which is
typically only needed when a Makefile sets a default value for a
variable that is inappropriate for cross-compilation using the "="
operator rather than the "?=" operator.
.. _migration-2.1-libexecdir-reverted-to-prefix-libexec:
``libexecdir`` Reverted to ``${prefix}/libexec``
------------------------------------------------
The use of ``${libdir}/${BPN}`` as ``libexecdir`` is different as
compared to all other mainstream distributions, which either uses
``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the
GNU Coding Standards (i.e.
https://www.gnu.org/prep/standards/html_node/Directory-Variables.html)
that suggest ``${prefix}/libexec`` and also notes that any
package-specific nesting should be done by the package itself. Finally,
having ``libexecdir`` change between recipes makes it very difficult for
different recipes to invoke binaries that have been installed into
``libexecdir``. The Filesystem Hierarchy Standard (i.e.
http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
recognizes the use of ``${prefix}/libexec/``, giving distributions the
choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without
breaking FHS.
.. _migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files:
``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files
--------------------------------------------------------
For recipes inheriting the :ref:`autotools <ref-classes-autotools>`
class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for
``autoconf``. The reason for this change is because the
``ac_cv_sizeof_off_t`` value is not necessarily static per architecture
as was previously assumed. Rather, the value changes based on whether
large file support is enabled. For most software that uses ``autoconf``,
this change should not be a problem. However, if you have a recipe that
bypasses the standard :ref:`ref-tasks-configure` task
from the ``autotools`` class and the software the recipe is building
uses a very old version of ``autoconf``, the recipe might be incapable
of determining the correct size of ``off_t`` during ``do_configure``.
The best course of action is to patch the software as necessary to allow
the default implementation from the ``autotools`` class to work such
that ``autoreconf`` succeeds and produces a working configure script,
and to remove the overridden ``do_configure`` task such that the default
implementation does get used.
.. _migration-2.1-image-generation-split-out-from-filesystem-generation:
Image Generation is Now Split Out from Filesystem Generation
------------------------------------------------------------
Previously, for image recipes the :ref:`ref-tasks-rootfs`
task assembled the filesystem and then from that filesystem generated
images. With this Yocto Project release, image generation is split into
separate ```do_image_*`` <#ref-tasks-image>`__ tasks for clarity both in
operation and in the code.
For most cases, this change does not present any problems. However, if
you have made customizations that directly modify the ``do_rootfs`` task
or that mention ``do_rootfs``, you might need to update those changes.
In particular, if you had added any tasks after ``do_rootfs``, you
should make edits so that those tasks are after the
```do_image_complete`` <#ref-tasks-image-complete>`__ task rather than
after ``do_rootfs`` so that the your added tasks run at the correct
time.
A minor part of this restructuring is that the post-processing
definitions and functions have been moved from the
:ref:`image <ref-classes-image>` class to the
:ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally,
however, they remain unchanged.
.. _migration-2.1-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed in the 2.1 release:
- ``gcc`` version 4.8: Versions 4.9 and 5.3 remain.
- ``qt4``: All support for Qt 4.x has been moved out to a separate
``meta-qt4`` layer because Qt 4 is no longer supported upstream.
- ``x11vnc``: Moved to the ``meta-oe`` layer.
- ``linux-yocto-3.14``: No longer supported.
- ``linux-yocto-3.19``: No longer supported.
- ``libjpeg``: Replaced by the ``libjpeg-turbo`` recipe.
- ``pth``: Became obsolete.
- ``liboil``: Recipe is no longer needed and has been moved to the
``meta-multimedia`` layer.
- ``gtk-theme-torturer``: Recipe is no longer needed and has been moved
to the ``meta-gnome`` layer.
- ``gnome-mime-data``: Recipe is no longer needed and has been moved to
the ``meta-gnome`` layer.
- ``udev``: Replaced by the ``eudev`` recipe for compatibility when
using ``sysvinit`` with newer kernels.
- ``python-pygtk``: Recipe became obsolete.
- ``adt-installer``: Recipe became obsolete. See the "`ADT
Removed <#migration-2.1-adt-removed>`__" section for more
information.
.. _migration-2.1-class-changes:
Class Changes
-------------
The following classes have changed:
- ``autotools_stage``: Removed because the
:ref:`autotools <ref-classes-autotools>` class now provides its
functionality. Recipes that inherited from ``autotools_stage`` should
now inherit from ``autotools`` instead.
- ``boot-directdisk``: Merged into the ``image-vm`` class. The
``boot-directdisk`` class was rarely directly used. Consequently,
this change should not cause any issues.
- ``bootimg``: Merged into the
:ref:`image-live <ref-classes-image-live>` class. The ``bootimg``
class was rarely directly used. Consequently, this change should not
cause any issues.
- ``packageinfo``: Removed due to its limited use by the Hob UI, which
has itself been removed.
.. _migration-2.1-build-system-ui-changes:
Build System User Interface Changes
-----------------------------------
The following changes have been made to the build system user interface:
- *Hob GTK+-based UI*: Removed because it is unmaintained and based on
the outdated GTK+ 2 library. The Toaster web-based UI is much more
capable and is actively maintained. See the
":ref:`toaster-manual/toaster-manual-setup-and-use:using the toaster web interface`"
section in the Toaster User Manual for more information on this
interface.
- *"puccho" BitBake UI*: Removed because is unmaintained and no longer
useful.
.. _migration-2.1-adt-removed:
ADT Removed
-----------
The Application Development Toolkit (ADT) has been removed because its
functionality almost completely overlapped with the :ref:`standard
SDK <sdk-manual/sdk-using:using the standard sdk>` and the
:ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For
information on these SDKs and how to build and use them, see the
:doc:`../sdk-manual/sdk-manual` manual.
.. note::
The Yocto Project Eclipse IDE Plug-in is still supported and is not
affected by this change.
.. _migration-2.1-poky-reference-distribution-changes:
Poky Reference Distribution Changes
-----------------------------------
The following changes have been made for the Poky distribution:
- The ``meta-yocto`` layer has been renamed to ``meta-poky`` to better
match its purpose, which is to provide the Poky reference
distribution. The ``meta-yocto-bsp`` layer retains its original name
since it provides reference machines for the Yocto Project and it is
otherwise unrelated to Poky. References to ``meta-yocto`` in your
``conf/bblayers.conf`` should automatically be updated, so you should
not need to change anything unless you are relying on this naming
elsewhere.
- The :ref:`uninative <ref-classes-uninative>` class is now enabled
by default in Poky. This class attempts to isolate the build system
from the host distribution's C library and makes re-use of native
shared state artifacts across different host distributions practical.
With this class enabled, a tarball containing a pre-built C library
is downloaded at the start of the build.
The ``uninative`` class is enabled through the
``meta/conf/distro/include/yocto-uninative.inc`` file, which for
those not using the Poky distribution, can include to easily enable
the same functionality.
Alternatively, if you wish to build your own ``uninative`` tarball,
you can do so by building the ``uninative-tarball`` recipe, making it
available to your build machines (e.g. over HTTP/HTTPS) and setting a
similar configuration as the one set by ``yocto-uninative.inc``.
- Static library generation, for most cases, is now disabled by default
in the Poky distribution. Disabling this generation saves some build
time as well as the size used for build output artifacts.
Disabling this library generation is accomplished through a
``meta/conf/distro/include/no-static-libs.inc``, which for those not
using the Poky distribution can easily include to enable the same
functionality.
Any recipe that needs to opt-out of having the "--disable-static"
option specified on the configure command line either because it is
not a supported option for the configure script or because static
libraries are needed should set the following variable:
DISABLE_STATIC = ""
- The separate ``poky-tiny`` distribution now uses the musl C library
instead of a heavily pared down ``glibc``. Using musl results in a
smaller distribution and facilitates much greater maintainability
because musl is designed to have a small footprint.
If you have used ``poky-tiny`` and have customized the ``glibc``
configuration you will need to redo those customizations with musl
when upgrading to the new release.
.. _migration-2.1-packaging-changes:
Packaging Changes
-----------------
The following changes have been made to packaging:
- The ``runuser`` and ``mountpoint`` binaries, which were previously in
the main ``util-linux`` package, have been split out into the
``util-linux-runuser`` and ``util-linux-mountpoint`` packages,
respectively.
- The ``python-elementtree`` package has been merged into the
``python-xml`` package.
.. _migration-2.1-tuning-file-changes:
Tuning File Changes
-------------------
The following changes have been made to the tuning files:
- The "no-thumb-interwork" tuning feature has been dropped from the ARM
tune include files. Because interworking is required for ARM EABI,
attempting to disable it through a tuning feature no longer makes
sense.
.. note::
Support for ARM OABI was deprecated in gcc 4.7.
- The ``tune-cortexm*.inc`` and ``tune-cortexr4.inc`` files have been
removed because they are poorly tested. Until the OpenEmbedded build
system officially gains support for CPUs without an MMU, these tuning
files would probably be better maintained in a separate layer if
needed.
.. _migration-2.1-supporting-gobject-introspection:
Supporting GObject Introspection
--------------------------------
This release supports generation of GLib Introspective Repository (GIR)
files through GObject introspection, which is the standard mechanism for
accessing GObject-based software from runtime environments. You can
enable, disable, and test the generation of this data. See the
":ref:`dev-manual/dev-manual-common-tasks:enabling gobject introspection support`"
section in the Yocto Project Development Tasks Manual for more
information.
.. _migration-2.1-miscellaneous-changes:
Miscellaneous Changes
---------------------
These additional changes exist:
- The minimum Git version has been increased to 1.8.3.1. If your host
distribution does not provide a sufficiently recent version, you can
install the buildtools, which will provide it. See the "`Required
Git, tar, Python and gcc
Versions <#required-git-tar-python-and-gcc-versions>`__" section for
more information on the buildtools tarball.
- The buggy and incomplete support for the RPM version 4 package
manager has been removed. The well-tested and maintained support for
RPM version 5 remains.
- Previously, the following list of packages were removed if
package-management was not in
:term:`IMAGE_FEATURES`, regardless of any
dependencies:
::
update-rc.d
base-passwd
shadow
update-alternatives
run-postinsts With the Yocto Project 2.1 release, these packages are
only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since
they might still be needed for a read-write image even in the absence
of a package manager (e.g. if users need to be added, modified, or
removed at runtime).
- The
:ref:`devtool modify <sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`
command now defaults to extracting the source since that is most
commonly expected. The "-x" or "--extract" options are now no-ops. If
you wish to provide your own existing source tree, you will now need
to specify either the "-n" or "--no-extract" options when running
``devtool modify``.
- If the formfactor for a machine is either not supplied or does not
specify whether a keyboard is attached, then the default is to assume
a keyboard is attached rather than assume no keyboard. This change
primarily affects the Sato UI.
- The ``.debug`` directory packaging is now automatic. If your recipe
builds software that installs binaries into directories other than
the standard ones, you no longer need to take care of setting
``FILES_${PN}-dbg`` to pick up the resulting ``.debug`` directories
as these directories are automatically found and added.
- Inaccurate disk and CPU percentage data has been dropped from
``buildstats`` output. This data has been replaced with
``getrusage()`` data and corrected IO statistics. You will probably
need to update any custom code that reads the ``buildstats`` data.
- The ``meta/conf/distro/include/package_regex.inc`` is now deprecated.
The contents of this file have been moved to individual recipes.
.. note::
Because this file will likely be removed in a future Yocto Project
release, it is suggested that you remove any references to the
file that might be in your configuration.
- The ``v86d/uvesafb`` has been removed from the ``genericx86`` and
``genericx86-64`` reference machines, which are provided by the
``meta-yocto-bsp`` layer. Most modern x86 boards do not rely on this
file and it only adds kernel error messages during startup. If you do
still need to support ``uvesafb``, you can simply add ``v86d`` to
your image.
- Build sysroot paths are now removed from debug symbol files. Removing
these paths means that remote GDB using an unstripped build system
sysroot will no longer work (although this was never documented to
work). The supported method to accomplish something similar is to set
``IMAGE_GEN_DEBUGFS`` to "1", which will generate a companion debug
image containing unstripped binaries and associated debug sources
alongside the image.
documentation/ref-manual/migration-2.2.rst
+451
View File
@@ -0,0 +1,451 @@
Moving to the Yocto Project 2.2 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.2 Release from the prior release.
.. _migration-2.2-minimum-kernel-version:
Minimum Kernel Version
----------------------
The minimum kernel version for the target system and for SDK is now
3.2.0, due to the upgrade to ``glibc 2.24``. Specifically, for
AArch64-based targets the version is 3.14. For Nios II-based targets,
the minimum kernel version is 3.19.
.. note::
For x86 and x86_64, you can reset
OLDEST_KERNEL
to anything down to 2.6.32 if desired.
.. _migration-2.2-staging-directories-in-sysroot-simplified:
Staging Directories in Sysroot Has Been Simplified
--------------------------------------------------
The way directories are staged in sysroot has been simplified and
introduces the new :term:`SYSROOT_DIRS`,
:term:`SYSROOT_DIRS_NATIVE`, and
:term:`SYSROOT_DIRS_BLACKLIST`. See the
`v2 patch series on the OE-Core Mailing
List <http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121365.html>`__
for additional information.
.. _migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled:
Removal of Old Images and Other Files in ``tmp/deploy`` Now Enabled
-------------------------------------------------------------------
Removal of old images and other files in ``tmp/deploy/`` is now enabled
by default due to a new staging method used for those files. As a result
of this change, the ``RM_OLD_IMAGE`` variable is now redundant.
.. _migration-2.2-python-changes:
Python Changes
--------------
The following changes for Python occurred:
.. _migration-2.2-bitbake-now-requires-python-3.4:
BitBake Now Requires Python 3.4+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
BitBake requires Python 3.4 or greater.
.. _migration-2.2-utf-8-locale-required-on-build-host:
UTF-8 Locale Required on Build Host
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A UTF-8 locale is required on the build host due to Python 3. Since
C.UTF-8 is not a standard, the default is en_US.UTF-8.
.. _migration-2.2-metadata-now-must-use-python-3-syntax:
Metadata Must Now Use Python 3 Syntax
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The metadata is now required to use Python 3 syntax. For help preparing
metadata, see any of the many Python 3 porting guides available.
Alternatively, you can reference the conversion commits for Bitbake and
you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are
particular areas of interest:
- subprocess command-line pipes needing locale decoding
- the syntax for octal values changed
- the ``iter*()`` functions changed name \* iterators now return views, not lists
- changed names for Python modules
.. _migration-2.2-target-python-recipes-switched-to-python-3:
Target Python Recipes Switched to Python 3
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most target Python recipes have now been switched to Python 3.
Unfortunately, systems using RPM as a package manager and providing
online package-manager support through SMART still require Python 2.
.. note::
Python 2 and recipes that use it can still be built for the target as
with previous versions.
.. _migration-2.2-buildtools-tarball-includes-python-3:
``buildtools-tarball`` Includes Python 3
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``buildtools-tarball`` now includes Python 3.
.. _migration-2.2-uclibc-replaced-by-musl:
uClibc Replaced by musl
-----------------------
uClibc has been removed in favor of musl. Musl has matured, is better
maintained, and is compatible with a wider range of applications as
compared to uClibc.
.. _migration-2.2-B-no-longer-default-working-directory-for-tasks:
``${B}`` No Longer Default Working Directory for Tasks
------------------------------------------------------
``${``\ :term:`B`\ ``}`` is no longer the default working
directory for tasks. Consequently, any custom tasks you define now need
to either have the
``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag
set, or the task needs to change into the appropriate working directory
manually (e.g using ``cd`` for a shell task).
.. note::
The preferred method is to use the
[dirs]
flag.
.. _migration-2.2-runqemu-ported-to-python:
``runqemu`` Ported to Python
----------------------------
``runqemu`` has been ported to Python and has changed behavior in some
cases. Previous usage patterns continue to be supported.
The new ``runqemu`` is a Python script. Machine knowledge is no longer
hardcoded into ``runqemu``. You can choose to use the ``qemuboot``
configuration file to define the BSP's own arguments and to make it
bootable with ``runqemu``. If you use a configuration file, use the
following form:
::
image-name-machine.qemuboot.conf
The configuration file
enables fine-grained tuning of options passed to QEMU without the
``runqemu`` script hard-coding any knowledge about different machines.
Using a configuration file is particularly convenient when trying to use
QEMU with machines other than the ``qemu*`` machines in
:term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the
``qemuboot`` class when the root filesystem is being build (i.e. build
rootfs). QEMU boot arguments can be set in BSP's configuration file and
the ``qemuboot`` class will save them to ``qemuboot.conf``.
If you want to use ``runqemu`` without a configuration file, use the
following command form:
::
$ runqemu machine rootfs kernel [options]
Supported machines are as follows:
- qemuarm
- qemuarm64
- qemux86
- qemux86-64
- qemuppc
- qemumips
- qemumips64
- qemumipsel
- qemumips64el
Consider the
following example, which uses the ``qemux86-64`` machine, provides a
root filesystem, provides an image, and uses the ``nographic`` option: ::
$ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
Following is a list of variables that can be set in configuration files
such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``:
.. note::
"QB" means "QEMU Boot".
::
QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386")
QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor")
QB_DEFAULT_KERNEL: Default kernel to boot (e.g. "bzImage")
QB_DEFAULT_FSTYPE: Default FSTYPE to boot (e.g. "ext4")
QB_MEM: Memory (e.g. "-m 512")
QB_MACHINE: QEMU machine (e.g. "-machine virt")
QB_CPU: QEMU cpu (e.g. "-cpu qemu32")
QB_CPU_KVM: Similar to QB_CPU except used for kvm support (e.g. "-cpu kvm64")
QB_KERNEL_CMDLINE_APPEND: Options to append to the kernel's -append
option (e.g. "console=ttyS0 console=tty")
QB_DTB: QEMU dtb name
QB_AUDIO_DRV: QEMU audio driver (e.g. "alsa", set it when support audio)
QB_AUDIO_OPT: QEMU audio option (e.g. "-soundhw ac97,es1370"), which is used
when QB_AUDIO_DRV is set.
QB_KERNEL_ROOT: Kernel's root (e.g. /dev/vda)
QB_TAP_OPT: Network option for 'tap' mode (e.g.
"-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no -device virtio-net-device,netdev=net0").
runqemu will replace "@TAP@" with the one that is used, such as tap0, tap1 ...
QB_SLIRP_OPT: Network option for SLIRP mode (e.g. "-netdev user,id=net0 -device virtio-net-device,netdev=net0")
QB_ROOTFS_OPT: Used as rootfs (e.g.
"-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0").
runqemu will replace "@ROOTFS@" with the one which is used, such as
core-image-minimal-qemuarm64.ext4.
QB_SERIAL_OPT: Serial port (e.g. "-serial mon:stdio")
QB_TCPSERIAL_OPT: tcp serial port option (e.g.
" -device virtio-serial-device -chardev socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon"
runqemu will replace "@PORT@" with the port number which is used.
To use ``runqemu``, set :term:`IMAGE_CLASSES` as
follows and run ``runqemu``:
.. note::
For command-line syntax, use
runqemu help
.
::
IMAGE_CLASSES += "qemuboot"
.. _migration-2.2-default-linker-hash-style-changed:
Default Linker Hash Style Changed
---------------------------------
The default linker hash style for ``gcc-cross`` is now "sysv" in order
to catch recipes that are building software without using the
OpenEmbedded :term:`LDFLAGS`. This change could result in
seeing some "No GNU_HASH in the elf binary" QA issues when building such
recipes. You need to fix these recipes so that they use the expected
``LDFLAGS``. Depending on how the software is built, the build system
used by the software (e.g. a Makefile) might need to be patched.
However, sometimes making this fix is as simple as adding the following
to the recipe:
::
TARGET_CC_ARCH += "${LDFLAGS}"
.. _migration-2.2-kernel-image-base-name-no-longer-uses-kernel-imagetype:
``KERNEL_IMAGE_BASE_NAME`` no Longer Uses ``KERNEL_IMAGETYPE``
--------------------------------------------------------------
The ``KERNEL_IMAGE_BASE_NAME`` variable no longer uses the
:term:`KERNEL_IMAGETYPE` variable to create the
image's base name. Because the OpenEmbedded build system can now build
multiple kernel image types, this part of the kernel image base name as
been removed leaving only the following:
::
KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
If you have recipes or
classes that use ``KERNEL_IMAGE_BASE_NAME`` directly, you might need to
update the references to ensure they continue to work.
.. _migration-2.2-bitbake-changes:
BitBake Changes
---------------
The following changes took place for BitBake:
- The "goggle" UI and standalone image-writer tool have been removed as
they both require GTK+ 2.0 and were not being maintained.
- The Perforce fetcher now supports :term:`SRCREV` for
specifying the source revision to use, be it
``${``\ :term:`AUTOREV`\ ``}``, changelist number,
p4date, or label, in preference to separate
:term:`SRC_URI` parameters to specify these. This
change is more in-line with how the other fetchers work for source
control systems. Recipes that fetch from Perforce will need to be
updated to use ``SRCREV`` in place of specifying the source revision
within ``SRC_URI``.
- Some of BitBake's internal code structures for accessing the recipe
cache needed to be changed to support the new multi-configuration
functionality. These changes will affect external tools that use
BitBake's tinfoil module. For information on these changes, see the
changes made to the scripts supplied with OpenEmbedded-Core:
`1 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>`__
and
`2 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`__.
- The task management code has been rewritten to avoid using ID
indirection in order to improve performance. This change is unlikely
to cause any problems for most users. However, the setscene
verification function as pointed to by
``BB_SETSCENE_VERIFY_FUNCTION`` needed to change signature.
Consequently, a new variable named ``BB_SETSCENE_VERIFY_FUNCTION2``
has been added allowing multiple versions of BitBake to work with
suitably written metadata, which includes OpenEmbedded-Core and Poky.
Anyone with custom BitBake task scheduler code might also need to
update the code to handle the new structure.
.. _migration-2.2-swabber-has-been-removed:
Swabber has Been Removed
------------------------
Swabber, a tool that was intended to detect host contamination in the
build process, has been removed, as it has been unmaintained and unused
for some time and was never particularly effective. The OpenEmbedded
build system has since incorporated a number of mechanisms including
enhanced QA checks that mean that there is less of a need for such a
tool.
.. _migration-2.2-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``augeas``: No longer needed and has been moved to ``meta-oe``.
- ``directfb``: Unmaintained and has been moved to ``meta-oe``.
- ``gcc``: Removed 4.9 version. Versions 5.4 and 6.2 are still present.
- ``gnome-doc-utils``: No longer needed.
- ``gtk-doc-stub``: Replaced by ``gtk-doc``.
- ``gtk-engines``: No longer needed and has been moved to
``meta-gnome``.
- ``gtk-sato-engine``: Became obsolete.
- ``libglade``: No longer needed and has been moved to ``meta-oe``.
- ``libmad``: Unmaintained and functionally replaced by ``libmpg123``.
``libmad`` has been moved to ``meta-oe``.
- ``libowl``: Became obsolete.
- ``libxsettings-client``: No longer needed.
- ``oh-puzzles``: Functionally replaced by ``puzzles``.
- ``oprofileui``: Became obsolete. OProfile has been largely supplanted
by perf.
- ``packagegroup-core-directfb.bb``: Removed.
- ``core-image-directfb.bb``: Removed.
- ``pointercal``: No longer needed and has been moved to ``meta-oe``.
- ``python-imaging``: No longer needed and moved to ``meta-python``
- ``python-pyrex``: No longer needed and moved to ``meta-python``.
- ``sato-icon-theme``: Became obsolete.
- ``swabber-native``: Swabber has been removed. See the `entry on
Swabber <#migration-2.2-swabber-has-been-removed>`__.
- ``tslib``: No longer needed and has been moved to ``meta-oe``.
- ``uclibc``: Removed in favor of musl.
- ``xtscal``: No longer needed and moved to ``meta-oe``
.. _migration-2.2-removed-classes:
Removed Classes
---------------
The following classes have been removed:
- ``distutils-native-base``: No longer needed.
- ``distutils3-native-base``: No longer needed.
- ``sdl``: Only set :term:`DEPENDS` and
:term:`SECTION`, which are better set within the
recipe instead.
- ``sip``: Mostly unused.
- ``swabber``: See the `entry on
Swabber <#migration-2.2-swabber-has-been-removed>`__.
.. _migration-2.2-minor-packaging-changes:
Minor Packaging Changes
-----------------------
The following minor packaging changes have occurred:
- ``grub``: Split ``grub-editenv`` into its own package.
- ``systemd``: Split container and vm related units into a new package,
systemd-container.
- ``util-linux``: Moved ``prlimit`` to a separate
``util-linux-prlimit`` package.
.. _migration-2.2-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes have occurred:
- ``package_regex.inc``: Removed because the definitions
``package_regex.inc`` previously contained have been moved to their
respective recipes.
- Both ``devtool add`` and ``recipetool create`` now use a fixed
:term:`SRCREV` by default when fetching from a Git
repository. You can override this in either case to use
``${``\ :term:`AUTOREV`\ ``}`` instead by using the
``-a`` or ``DASHDASHautorev`` command-line option
- ``distcc``: GTK+ UI is now disabled by default.
- ``packagegroup-core-tools-testapps``: Removed Piglit.
- ``image.bbclass``: Renamed COMPRESS(ION) to CONVERSION. This change
means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and
``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``,
``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*``
variable names will still work in the 2.2 release but metadata that
does not need to be backwards-compatible should be changed to use the
new names as the ``COMPRESS*`` ones will be removed in a future
release.
- ``gtk-doc``: A full version of ``gtk-doc`` is now made available.
However, some old software might not be capable of using the current
version of ``gtk-doc`` to build documentation. You need to change
recipes that build such software so that they explicitly disable
building documentation with ``gtk-doc``.
documentation/ref-manual/migration-2.3.rst
+530
View File
@@ -0,0 +1,530 @@
Moving to the Yocto Project 2.3 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.3 Release from the prior release.
.. _migration-2.3-recipe-specific-sysroots:
Recipe-specific Sysroots
------------------------
The OpenEmbedded build system now uses one sysroot per recipe to resolve
long-standing issues with configuration script auto-detection of
undeclared dependencies. Consequently, you might find that some of your
previously written custom recipes are missing declared dependencies,
particularly those dependencies that are incidentally built earlier in a
typical build process and thus are already likely to be present in the
shared sysroot in previous releases.
Consider the following:
- *Declare Build-Time Dependencies:* Because of this new feature, you
must explicitly declare all build-time dependencies for your recipe.
If you do not declare these dependencies, they are not populated into
the sysroot for the recipe.
- *Specify Pre-Installation and Post-Installation Native Tool
Dependencies:* You must specifically specify any special native tool
dependencies of ``pkg_preinst`` and ``pkg_postinst`` scripts by using
the :term:`PACKAGE_WRITE_DEPS` variable.
Specifying these dependencies ensures that these tools are available
if these scripts need to be run on the build host during the
:ref:`ref-tasks-rootfs` task.
As an example, see the ``dbus`` recipe. You will see that this recipe
has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in
:term:`DISTRO_FEATURES`. In the example,
``systemd-systemctl-native`` is added to ``PACKAGE_WRITE_DEPS``,
which is also conditional on "systemd" being in ``DISTRO_FEATURES``.
- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to
examine any recipe that uses ``SSTATEPOSTINSTFUNCS`` and determine
steps to take.
Functions added to ``SSTATEPOSTINSTFUNCS`` are still called as they
were in previous Yocto Project releases. However, since a separate
sysroot is now being populated for every recipe and if existing
functions being called through ``SSTATEPOSTINSTFUNCS`` are doing
relocation, then you will need to change these to use a
post-installation script that is installed by a function added to
:term:`SYSROOT_PREPROCESS_FUNCS`.
For an example, see the ``pixbufcache`` class in ``meta/classes/`` in
the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`.
.. note::
The
SSTATEPOSTINSTFUNCS
variable itself is now deprecated in favor of the
do_populate_sysroot[postfuncs]
task. Consequently, if you do still have any function or functions
that need to be called after the sysroot component is created for
a recipe, then you would be well advised to take steps to use a
post installation script as described previously. Taking these
steps prepares your code for when
SSTATEPOSTINSTFUNCS
is removed in a future Yocto Project release.
- *Specify the Sysroot when Using Certain External Scripts:* Because
the shared sysroot is now gone, the scripts
``oe-find-native-sysroot`` and ``oe-run-native`` have been changed
such that you need to specify which recipe's
:term:`STAGING_DIR_NATIVE` is used.
.. note::
You can find more information on how recipe-specific sysroots work in
the "
staging.bbclass
" section.
.. _migration-2.3-path-variable:
``PATH`` Variable
-----------------
Within the environment used to run build tasks, the environment variable
``PATH`` is now sanitized such that the normal native binary paths
(``/bin``, ``/sbin``, ``/usr/bin`` and so forth) are removed and a
directory containing symbolic links linking only to the binaries from
the host mentioned in the :term:`HOSTTOOLS` and
:term:`HOSTTOOLS_NONFATAL` variables is added
to ``PATH``.
Consequently, any native binaries provided by the host that you need to
call needs to be in one of these two variables at the configuration
level.
Alternatively, you can add a native recipe (i.e. ``-native``) that
provides the binary to the recipe's :term:`DEPENDS`
value.
.. note::
PATH
is not sanitized in the same way within
devshell
. If it were, you would have difficulty running host tools for
development and debugging within the shell.
.. _migration-2.3-scripts:
Changes to Scripts
------------------
The following changes to scripts took place:
- ``oe-find-native-sysroot``: The usage for the
``oe-find-native-sysroot`` script has changed to the following:
::
$ . oe-find-native-sysroot recipe
You must now supply a recipe for recipe
as part of the command. Prior to the Yocto Project &DISTRO; release, it
was not necessary to provide the script with the command.
- ``oe-run-native``: The usage for the ``oe-run-native`` script has
changed to the following:
::
$ oe-run-native native_recipe tool
You must
supply the name of the native recipe and the tool you want to run as
part of the command. Prior to the Yocto Project DISTRO release, it
was not necessary to provide the native recipe with the command.
- ``cleanup-workdir``: The ``cleanup-workdir`` script has been
removed because the script was found to be deleting files it should
not have, which lead to broken build trees. Rather than trying to
delete portions of :term:`TMPDIR` and getting it wrong,
it is recommended that you delete ``TMPDIR`` and have it restored
from shared state (sstate) on subsequent builds.
- ``wipe-sysroot``: The ``wipe-sysroot`` script has been removed as
it is no longer needed with recipe-specific sysroots.
.. _migration-2.3-functions:
Changes to Functions
--------------------
The previously deprecated ``bb.data.getVar()``, ``bb.data.setVar()``,
and related functions have been removed in favor of ``d.getVar()``,
``d.setVar()``, and so forth.
You need to fix any references to these old functions.
.. _migration-2.3-bitbake-changes:
BitBake Changes
---------------
The following changes took place for BitBake:
- *BitBake's Graphical Dependency Explorer UI Replaced:* BitBake's
graphical dependency explorer UI ``depexp`` was replaced by
``taskexp`` ("Task Explorer"), which provides a graphical way of
exploring the ``task-depends.dot`` file. The data presented by Task
Explorer is much more accurate than the data that was presented by
``depexp``. Being able to visualize the data is an often requested
feature as standard ``*.dot`` file viewers cannot usual cope with the
size of the ``task-depends.dot`` file.
- *BitBake "-g" Output Changes:* The ``package-depends.dot`` and
``pn-depends.dot`` files as previously generated using the
``bitbake -g`` command have been removed. A ``recipe-depends.dot``
file is now generated as a collapsed version of ``task-depends.dot``
instead.
The reason for this change is because ``package-depends.dot`` and
``pn-depends.dot`` largely date back to a time before task-based
execution and do not take into account task-level dependencies
between recipes, which could be misleading.
- *Mirror Variable Splitting Changes:* Mirror variables including
:term:`MIRRORS`, :term:`PREMIRRORS`,
and :term:`SSTATE_MIRRORS` can now separate
values entirely with spaces. Consequently, you no longer need "\\n".
BitBake looks for pairs of values, which simplifies usage. There
should be no change required to existing mirror variable values
themselves.
- *The Subversion (SVN) Fetcher Uses an "ssh" Parameter and Not an
"rsh" Parameter:* The SVN fetcher now takes an "ssh" parameter
instead of an "rsh" parameter. This new optional parameter is used
when the "protocol" parameter is set to "svn+ssh". You can only use
the new parameter to specify the ``ssh`` program used by SVN. The SVN
fetcher passes the new parameter through the ``SVN_SSH`` environment
variable during the :ref:`ref-tasks-fetch` task.
See the ":ref:`bitbake:svn-fetcher`"
section in the BitBake
User Manual for additional information.
- ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
Removed: Because the mechanism they were part of is no longer
necessary with recipe-specific sysroots, the
``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
variables have been removed.
.. _migration-2.3-absolute-symlinks:
Absolute Symbolic Links
-----------------------
Absolute symbolic links (symlinks) within staged files are no longer
permitted and now trigger an error. Any explicit creation of symlinks
can use the ``lnr`` script, which is a replacement for ``ln -r``.
If the build scripts in the software that the recipe is building are
creating a number of absolute symlinks that need to be corrected, you
can inherit ``relative_symlinks`` within the recipe to turn those
absolute symlinks into relative symlinks.
.. _migration-2.3-gplv2-and-gplv3-moves:
GPLv2 Versions of GPLv3 Recipes Moved
-------------------------------------
Older GPLv2 versions of GPLv3 recipes have moved to a separate
``meta-gplv2`` layer.
If you use :term:`INCOMPATIBLE_LICENSE` to
exclude GPLv3 or set :term:`PREFERRED_VERSION`
to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
``meta-gplv2`` layer to your configuration.
.. note::
You can find
meta-gplv2
layer in the OpenEmbedded layer index at
.
These relocated GPLv2 recipes do not receive the same level of
maintenance as other core recipes. The recipes do not get security fixes
and upstream no longer maintains them. In fact, the upstream community
is actively hostile towards people that use the old versions of the
recipes. Moving these recipes into a separate layer both makes the
different needs of the recipes clearer and clearly identifies the number
of these recipes.
.. note::
The long-term solution might be to move to BSD-licensed replacements
of the GPLv3 components for those that need to exclude GPLv3-licensed
components from the target system. This solution will be investigated
for future Yocto Project releases.
.. _migration-2.3-package-management-changes:
Package Management Changes
--------------------------
The following package management changes took place:
- Smart package manager is replaced by DNF package manager. Smart has
become unmaintained upstream, is not ported to Python 3.x.
Consequently, Smart needed to be replaced. DNF is the only feasible
candidate.
The change in functionality is that the on-target runtime package
management from remote package feeds is now done with a different
tool that has a different set of command-line options. If you have
scripts that call the tool directly, or use its API, they need to be
fixed.
For more information, see the `DNF
Documentation <http://dnf.readthedocs.io/en/latest/>`__.
- Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons:
- DNF is API-incompatible with Rpm 5.x and porting it and
maintaining the port is non-trivial.
- Rpm 5.x itself has limited maintenance upstream, and the Yocto
Project is one of the very few remaining users.
- Berkeley DB 6.x is removed and Berkeley DB 5.x becomes the default:
- Version 6.x of Berkeley DB has largely been rejected by the open
source community due to its AGPLv3 license. As a result, most
mainstream open source projects that require DB are still
developed and tested with DB 5.x.
- In OE-core, the only thing that was requiring DB 6.x was Rpm 5.x.
Thus, no reason exists to continue carrying DB 6.x in OE-core.
- ``createrepo`` is replaced with ``createrepo_c``.
``createrepo_c`` is the current incarnation of the tool that
generates remote repository metadata. It is written in C as compared
to ``createrepo``, which is written in Python. ``createrepo_c`` is
faster and is maintained.
- Architecture-independent RPM packages are "noarch" instead of "all".
This change was made because too many places in DNF/RPM4 stack
already make that assumption. Only the filenames and the architecture
tag has changed. Nothing else has changed in OE-core system,
particularly in the :ref:`allarch.bbclass <ref-classes-allarch>`
class.
- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not
currently supported. This issue will be fully addressed in a future
Yocto Project release. See `defect
11209 <https://bugzilla.yoctoproject.org/show_bug.cgi?id=11209>`__
for more information on a solution to package feed signing with RPM
in the Yocto Project 2.3 release.
- OPKG now uses the libsolv backend for resolving package dependencies
by default. This is vastly superior to OPKG's internal ad-hoc solver
that was previously used. This change does have a small impact on
disk (around 500 KB) and memory footprint.
.. note::
For further details on this change, see the
commit message
.
.. _migration-2.3-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``linux-yocto 4.8``: Version 4.8 has been removed. Versions 4.1
(LTSI), 4.4 (LTS), 4.9 (LTS/LTSI) and 4.10 are now present.
- ``python-smartpm``: Functionally replaced by ``dnf``.
- ``createrepo``: Replaced by the ``createrepo-c`` recipe.
- ``rpmresolve``: No longer needed with the move to RPM 4 as RPM
itself is used instead.
- ``gstreamer``: Removed the GStreamer Git version recipes as they
have been stale. ``1.10.``\ x recipes are still present.
- ``alsa-conf-base``: Merged into ``alsa-conf`` since ``libasound``
depended on both. Essentially, no way existed to install only one of
these.
- ``tremor``: Moved to ``meta-multimedia``. Fixed-integer Vorbis
decoding is not needed by current hardware. Thus, GStreamer's ivorbis
plugin has been disabled by default eliminating the need for the
``tremor`` recipe in :term:`OpenEmbedded-Core (OE-Core)`.
- ``gummiboot``: Replaced by ``systemd-boot``.
.. _migration-2.3-wic-changes:
Wic Changes
-----------
The following changes have been made to Wic:
.. note::
For more information on Wic, see the "
Creating Partitioned Images Using Wic
" section in the Yocto Project Development Tasks Manual.
- *Default Output Directory Changed:* Wic's default output directory is
now the current directory by default instead of the unusual
``/var/tmp/wic``.
The "-o" and "--outdir" options remain unchanged and are used to
specify your preferred output directory if you do not want to use the
default directory.
- *fsimage Plug-in Removed:* The Wic fsimage plugin has been removed as
it duplicates functionality of the rawcopy plugin.
.. _migration-2.3-qa-changes:
QA Changes
----------
The following QA checks have changed:
- ``unsafe-references-in-binaries``: The
``unsafe-references-in-binaries`` QA check, which was disabled by
default, has now been removed. This check was intended to detect
binaries in ``/bin`` that link to libraries in ``/usr/lib`` and have
the case where the user has ``/usr`` on a separate filesystem to
``/``.
The removed QA check was buggy. Additionally, ``/usr`` residing on a
separate partition from ``/`` is now a rare configuration.
Consequently, ``unsafe-references-in-binaries`` was removed.
- ``file-rdeps``: The ``file-rdeps`` QA check is now an error by
default instead of a warning. Because it is an error instead of a
warning, you need to address missing runtime dependencies.
For additional information, see the
:ref:`insane <ref-classes-insane>` class and the "`Errors and
Warnings <#qa-errors-and-warnings>`__" section.
.. _migration-2.3-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes have occurred:
- In this release, a number of recipes have been changed to ignore the
``largefile`` :term:`DISTRO_FEATURES` item,
enabling large file support unconditionally. This feature has always
been enabled by default. Disabling the feature has not been widely
tested.
.. note::
Future releases of the Yocto Project will remove entirely the
ability to disable the
largefile
feature, which would make it unconditionally enabled everywhere.
- If the :term:`DISTRO_VERSION` value contains
the value of the :term:`DATE` variable, which is the
default between Poky releases, the ``DATE`` value is explicitly
excluded from ``/etc/issue`` and ``/etc/issue.net``, which is
displayed at the login prompt, in order to avoid conflicts with
Multilib enabled. Regardless, the ``DATE`` value is inaccurate if the
``base-files`` recipe is restored from shared state (sstate) rather
than rebuilt.
If you need the build date recorded in ``/etc/issue*`` or anywhere
else in your image, a better method is to define a post-processing
function to do it and have the function called from
:term:`ROOTFS_POSTPROCESS_COMMAND`.
Doing so ensures the value is always up-to-date with the created
image.
- Dropbear's ``init`` script now disables DSA host keys by default.
This change is in line with the systemd service file, which supports
RSA keys only, and with recent versions of OpenSSH, which deprecates
DSA host keys.
- The :ref:`buildhistory <ref-classes-buildhistory>` class now
correctly uses tabs as separators between all columns in
``installed-package-sizes.txt`` in order to aid import into other
tools.
- The ``USE_LDCONFIG`` variable has been replaced with the "ldconfig"
``DISTRO_FEATURES`` feature. Distributions that previously set:
::
USE_LDCONFIG = "0"
should now instead use the following:
::
DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig"
- The default value of
:term:`COPYLEFT_LICENSE_INCLUDE` now
includes all versions of AGPL licenses in addition to GPL and LGPL.
.. note::
The default list is not intended to be guaranteed as a complete
safe list. You should seek legal advice based on what you are
distributing if you are unsure.
- Kernel module packages are now suffixed with the kernel version in
order to allow module packages from multiple kernel versions to
co-exist on a target system. If you wish to return to the previous
naming scheme that does not include the version suffix, use the
following:
::
KERNEL_MODULE_PACKAGE_SUFFIX to ""
- Removal of ``libtool`` ``*.la`` files is now enabled by default. The
``*.la`` files are not actually needed on Linux and relocating them
is an unnecessary burden.
If you need to preserve these ``.la`` files (e.g. in a custom
distribution), you must change
:term:`INHERIT_DISTRO` such that
"remove-libtool" is not included in the value.
- Extensible SDKs built for GCC 5+ now refuse to install on a
distribution where the host GCC version is 4.8 or 4.9. This change
resulted from the fact that the installation is known to fail due to
the way the ``uninative`` shared state (sstate) package is built. See
the :ref:`uninative <ref-classes-uninative>` class for additional
information.
- All native and nativesdk recipes now use a separate
``DISTRO_FEATURES`` value instead of sharing the value used by
recipes for the target, in order to avoid unnecessary rebuilds.
The ``DISTRO_FEATURES`` for ``native`` recipes is
:term:`DISTRO_FEATURES_NATIVE` added to
an intersection of ``DISTRO_FEATURES`` and
:term:`DISTRO_FEATURES_FILTER_NATIVE`.
For nativesdk recipes, the corresponding variables are
:term:`DISTRO_FEATURES_NATIVESDK`
and
:term:`DISTRO_FEATURES_FILTER_NATIVESDK`.
- The ``FILESDIR`` variable, which was previously deprecated and rarely
used, has now been removed. You should change any recipes that set
``FILESDIR`` to set :term:`FILESPATH` instead.
- The ``MULTIMACH_HOST_SYS`` variable has been removed as it is no
longer needed with recipe-specific sysroots.
documentation/ref-manual/migration-2.4.rst
+327
View File
@@ -0,0 +1,327 @@
Moving to the Yocto Project 2.4 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.4 Release from the prior release.
.. _migration-2.4-memory-resident-mode:
Memory Resident Mode
--------------------
A persistent mode is now available in BitBake's default operation,
replacing its previous "memory resident mode" (i.e.
``oe-init-build-env-memres``). Now you only need to set
:term:`BB_SERVER_TIMEOUT` to a timeout (in
seconds) and BitBake's server stays resident for that amount of time
between invocations. The ``oe-init-build-env-memres`` script has been
removed since a separate environment setup script is no longer needed.
.. _migration-2.4-packaging-changes:
Packaging Changes
-----------------
This section provides information about packaging changes that have
occurred:
- ``python3`` Changes:
- The main "python3" package now brings in all of the standard
Python 3 distribution rather than a subset. This behavior matches
what is expected based on traditional Linux distributions. If you
wish to install a subset of Python 3, specify ``python-core`` plus
one or more of the individual packages that are still produced.
- ``python3``: The ``bz2.py``, ``lzma.py``, and
``_compression.py`` scripts have been moved from the
``python3-misc`` package to the ``python3-compression`` package.
- ``binutils``: The ``libbfd`` library is now packaged in a separate
"libbfd" package. This packaging saves space when certain tools (e.g.
``perf``) are installed. In such cases, the tools only need
``libbfd`` rather than all the packages in ``binutils``.
- ``util-linux`` Changes:
- The ``su`` program is now packaged in a separate "util-linux-su"
package, which is only built when "pam" is listed in the
:term:`DISTRO_FEATURES` variable.
``util-linux`` should not be installed unless it is needed because
``su`` is normally provided through the shadow file format. The
main ``util-linux`` package has runtime dependencies (i.e.
:term:`RDEPENDS`) on the ``util-linux-su`` package
when "pam" is in ``DISTRO_FEATURES``.
- The ``switch_root`` program is now packaged in a separate
"util-linux-switch-root" package for small initramfs images that
do not need the whole ``util-linux`` package or the busybox
binary, which are both much larger than ``switch_root``. The main
``util-linux`` package has a recommended runtime dependency (i.e.
:term:`RRECOMMENDS`) on the
``util-linux-switch-root`` package.
- The ``ionice`` program is now packaged in a separate
"util-linux-ionice" package. The main ``util-linux`` package has a
recommended runtime dependency (i.e. ``RRECOMMENDS``) on the
``util-linux-ionice`` package.
- ``initscripts``: The ``sushell`` program is now packaged in a
separate "initscripts-sushell" package. This packaging change allows
systems to pull ``sushell`` in when ``selinux`` is enabled. The
change also eliminates needing to pull in the entire ``initscripts``
package. The main ``initscripts`` package has a runtime dependency
(i.e. ``RDEPENDS``) on the ``sushell`` package when "selinux" is in
``DISTRO_FEATURES``.
- ``glib-2.0``: The ``glib-2.0`` package now has a recommended
runtime dependency (i.e. ``RRECOMMENDS``) on the ``shared-mime-info``
package, since large portions of GIO are not useful without the MIME
database. You can remove the dependency by using the
:term:`BAD_RECOMMENDATIONS` variable if
``shared-mime-info`` is too large and is not required.
- *Go Standard Runtime:* The Go standard runtime has been split out
from the main ``go`` recipe into a separate ``go-runtime`` recipe.
.. _migration-2.4-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``acpitests``: This recipe is not maintained.
- ``autogen-native``: No longer required by Grub, oe-core, or
meta-oe.
- ``bdwgc``: Nothing in OpenEmbedded-Core requires this recipe. It
has moved to meta-oe.
- ``byacc``: This recipe was only needed by rpm 5.x and has moved to
meta-oe.
- ``gcc (5.4)``: The 5.4 series dropped the recipe in favor of 6.3 /
7.2.
- ``gnome-common``: Deprecated upstream and no longer needed.
- ``go-bootstrap-native``: Go 1.9 does its own bootstrapping so this
recipe has been removed.
- ``guile``: This recipe was only needed by ``autogen-native`` and
``remake``. The recipe is no longer needed by either of these
programs.
- ``libclass-isa-perl``: This recipe was previously needed for LSB 4,
no longer needed.
- ``libdumpvalue-perl``: This recipe was previously needed for LSB 4,
no longer needed.
- ``libenv-perl``: This recipe was previously needed for LSB 4, no
longer needed.
- ``libfile-checktree-perl``: This recipe was previously needed for
LSB 4, no longer needed.
- ``libi18n-collate-perl``: This recipe was previously needed for LSB
4, no longer needed.
- ``libiconv``: This recipe was only needed for ``uclibc``, which was
removed in the previous release. ``glibc`` and ``musl`` have their
own implementations. ``meta-mingw`` still needs ``libiconv``, so it
has been moved to ``meta-mingw``.
- ``libpng12``: This recipe was previously needed for LSB. The
current ``libpng`` is 1.6.x.
- ``libpod-plainer-perl``: This recipe was previously needed for LSB
4, no longer needed.
- ``linux-yocto (4.1)``: This recipe was removed in favor of 4.4,
4.9, 4.10 and 4.12.
- ``mailx``: This recipe was previously only needed for LSB
compatibility, and upstream is defunct.
- ``mesa (git version only)``: The git version recipe was stale with
respect to the release version.
- ``ofono (git version only)``: The git version recipe was stale with
respect to the release version.
- ``portmap``: This recipe is obsolete and is superseded by
``rpcbind``.
- ``python3-pygpgme``: This recipe is old and unmaintained. It was
previously required by ``dnf``, which has switched to official
``gpgme`` Python bindings.
- ``python-async``: This recipe has been removed in favor of the
Python 3 version.
- ``python-gitdb``: This recipe has been removed in favor of the
Python 3 version.
- ``python-git``: This recipe was removed in favor of the Python 3
version.
- ``python-mako``: This recipe was removed in favor of the Python 3
version.
- ``python-pexpect``: This recipe was removed in favor of the Python
3 version.
- ``python-ptyprocess``: This recipe was removed in favor of Python
the 3 version.
- ``python-pycurl``: Nothing is using this recipe in
OpenEmbedded-Core (i.e. ``meta-oe``).
- ``python-six``: This recipe was removed in favor of the Python 3
version.
- ``python-smmap``: This recipe was removed in favor of the Python 3
version.
- ``remake``: Using ``remake`` as the provider of ``virtual/make`` is
broken. Consequently, this recipe is not needed in OpenEmbedded-Core.
.. _migration-2.4-kernel-device-tree-move:
Kernel Device Tree Move
-----------------------
Kernel Device Tree support is now easier to enable in a kernel recipe.
The Device Tree code has moved to a
:ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class.
Functionality is automatically enabled for any recipe that inherits the
:ref:`kernel <ref-classes-kernel>` class and sets the
:term:`KERNEL_DEVICETREE` variable. The
previous mechanism for doing this,
``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid
breakage, but triggers a deprecation warning. Future releases of the
Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``.
It is advisable to remove any ``require`` statements that request
``meta/recipes-kernel/linux/linux-dtb.inc`` from any custom kernel
recipes you might have. This will avoid breakage in post 2.4 releases.
.. _migration-2.4-package-qa-changes:
Package QA Changes
------------------
The following package QA changes took place:
- The "unsafe-references-in-scripts" QA check has been removed.
- If you refer to ``${COREBASE}/LICENSE`` within
:term:`LIC_FILES_CHKSUM` you receive a
warning because this file is a description of the license for
OE-Core. Use ``${COMMON_LICENSE_DIR}/MIT`` if your recipe is
MIT-licensed and you cannot use the preferred method of referring to
a file within the source tree.
.. _migration-2.4-readme-changes:
``README`` File Changes
-----------------------
The following are changes to ``README`` files:
- The main Poky ``README`` file has been moved to the ``meta-poky``
layer and has been renamed ``README.poky``. A symlink has been
created so that references to the old location work.
- The ``README.hardware`` file has been moved to ``meta-yocto-bsp``. A
symlink has been created so that references to the old location work.
- A ``README.qemu`` file has been created with coverage of the
``qemu*`` machines.
.. _migration-2.4-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following are additional changes:
- The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it
have been removed. You should remove this variable from any custom
recipes.
- The ``meta-yocto`` directory has been removed.
.. note::
In the Yocto Project 2.1 release
meta-yocto
was renamed to
meta-poky
and the
meta-yocto
subdirectory remained to avoid breaking existing configurations.
- The ``maintainers.inc`` file, which tracks maintainers by listing a
primary person responsible for each recipe in OE-Core, has been moved
from ``meta-poky`` to OE-Core (i.e. from
``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``).
- The :ref:`buildhistory <ref-classes-buildhistory>` class now makes
a single commit per build rather than one commit per subdirectory in
the repository. This behavior assumes the commits are enabled with
:term:`BUILDHISTORY_COMMIT` = "1", which
is typical. Previously, the ``buildhistory`` class made one commit
per subdirectory in the repository in order to make it easier to see
the changes for a particular subdirectory. To view a particular
change, specify that subdirectory as the last parameter on the
``git show`` or ``git diff`` commands.
- The ``x86-base.inc`` file, which is included by all x86-based machine
configurations, now sets :term:`IMAGE_FSTYPES`
using ``?=`` to "live" rather than appending with ``+=``. This change
makes the default easier to override.
- BitBake fires multiple "BuildStarted" events when multiconfig is
enabled (one per configuration). For more information, see the
":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User
Manual.
- By default, the ``security_flags.inc`` file sets a
:term:`GCCPIE` variable with an option to enable
Position Independent Executables (PIE) within ``gcc``. Enabling PIE
in the GNU C Compiler (GCC), makes Return Oriented Programming (ROP)
attacks much more difficult to execute.
- OE-Core now provides a ``bitbake-layers`` plugin that implements a
"create-layer" subcommand. The implementation of this subcommand has
resulted in the ``yocto-layer`` script being deprecated and will
likely be removed in the next Yocto Project release.
- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in
conjunction with the "wic" image type through ``CONVERSION_CMD``.
Consequently, the equivalent image types are now ``wic.vmdk``,
``wic.vdi``, and ``wic.qcow2``, respectively.
- ``do_image_<type>[depends]`` has replaced ``IMAGE_DEPENDS_<type>``.
If you have your own classes that implement custom image types, then
you need to update them.
- OpenSSL 1.1 has been introduced. However, the default is still 1.0.x
through the :term:`PREFERRED_VERSION`
variable. This preference is set is due to the remaining
compatibility issues with other software. The
:term:`PROVIDES` variable in the openssl 1.0 recipe
now includes "openssl10" as a marker that can be used in
:term:`DEPENDS` within recipes that build software
that still depend on OpenSSL 1.0.
- To ensure consistent behavior, BitBake's "-r" and "-R" options (i.e.
prefile and postfile), which are used to read or post-read additional
configuration files from the command line, now only affect the
current BitBake command. Before these BitBake changes, these options
would "stick" for future executions.
documentation/ref-manual/migration-2.5.rst
+310
View File
@@ -0,0 +1,310 @@
Moving to the Yocto Project 2.5 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.5 Release from the prior release.
.. _migration-2.5-packaging-changes:
Packaging Changes
-----------------
This section provides information about packaging changes that have
occurred:
- ``bind-libs``: The libraries packaged by the bind recipe are in a
separate ``bind-libs`` package.
- ``libfm-gtk``: The ``libfm`` GTK+ bindings are split into a
separate ``libfm-gtk`` package.
- ``flex-libfl``: The flex recipe splits out libfl into a separate
``flex-libfl`` package to avoid too many dependencies being pulled in
where only the library is needed.
- ``grub-efi``: The ``grub-efi`` configuration is split into a
separate ``grub-bootconf`` recipe. However, the dependency
relationship from ``grub-efi`` is through a virtual/grub-bootconf
provider making it possible to have your own recipe provide the
dependency. Alternatively, you can use a BitBake append file to bring
the configuration back into the ``grub-efi`` recipe.
- *armv7a Legacy Package Feed Support:* Legacy support is removed for
transitioning from ``armv7a`` to ``armv7a-vfp-neon`` in package
feeds, which was previously enabled by setting
``PKGARCHCOMPAT_ARMV7A``. This transition occurred in 2011 and active
package feeds should by now be updated to the new naming.
.. _migration-2.5-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- ``gcc``: The version 6.4 recipes are replaced by 7.x.
- ``gst-player``: Renamed to ``gst-examples`` as per upstream.
- ``hostap-utils``: This software package is obsolete.
- ``latencytop``: This recipe is no longer maintained upstream. The
last release was in 2009.
- ``libpfm4``: The only file that requires this recipe is
``oprofile``, which has been removed.
- ``linux-yocto``: The version 4.4, 4.9, and 4.10 recipes have been
removed. Versions 4.12, 4.14, and 4.15 remain.
- ``man``: This recipe has been replaced by modern ``man-db``
- ``mkelfimage``: This tool has been removed in the upstream coreboot
project, and is no longer needed with the removal of the ELF image
type.
- ``nativesdk-postinst-intercept``: This recipe is not maintained.
- ``neon``: This software package is no longer maintained upstream
and is no longer needed by anything in OpenEmbedded-Core.
- ``oprofile``: The functionality of this recipe is replaced by
``perf`` and keeping compatibility on an ongoing basis with ``musl``
is difficult.
- ``pax``: This software package is obsolete.
- ``stat``: This software package is not maintained upstream.
``coreutils`` provides a modern stat binary.
- ``zisofs-tools-native``: This recipe is no longer needed because
the compressed ISO image feature has been removed.
.. _migration-2.5-scripts-and-tools-changes:
Scripts and Tools Changes
-------------------------
The following are changes to scripts and tools:
- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The
``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts
previously shipped with poky but not in OpenEmbedded-Core have been
removed. These scripts are not maintained and are outdated. In many
cases, they are also limited in scope. The
``bitbake-layers create-layer`` command is a direct replacement for
``yocto-layer``. See the documentation to create a BSP or kernel
recipe in the ":ref:`bsp-guide/bsp:bsp kernel recipe example`" section.
- ``devtool finish``: ``devtool finish`` now exits with an error if
there are uncommitted changes or a rebase/am in progress in the
recipe's source repository. If this error occurs, there might be
uncommitted changes that will not be included in updates to the
patches applied by the recipe. A -f/--force option is provided for
situations that the uncommitted changes are inconsequential and you
want to proceed regardless.
- ``scripts/oe-setup-rpmrepo`` script: The functionality of
``scripts/oe-setup-rpmrepo`` is replaced by
``bitbake package-index``.
- ``scripts/test-dependencies.sh`` script: The script is largely made
obsolete by the recipe-specific sysroots functionality introduced in
the previous release.
.. _migration-2.5-bitbake-changes:
BitBake Changes
---------------
The following are BitBake changes:
- The ``--runall`` option has changed. There are two different
behaviors people might want:
- *Behavior A:* For a given target (or set of targets) look through
the task graph and run task X only if it is present and will be
built.
- *Behavior B:* For a given target (or set of targets) look through
the task graph and run task X if any recipe in the taskgraph has
such a target, even if it is not in the original task graph.
The ``--runall`` option now performs "Behavior B". Previously
``--runall`` behaved like "Behavior A". A ``--runonly`` option has
been added to retain the ability to perform "Behavior A".
- Several explicit "run this task for all recipes in the dependency
tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``,
and the ``*all`` tasks provided by the ``distrodata`` and
``archiver`` classes). There is a BitBake option to complete this for
any arbitrary task. For example:
::
bitbake <target> -c fetchall
should now be replaced with:
::
bitbake <target> --runall=fetch
.. _migration-2.5-python-and-python3-changes:
Python and Python 3 Changes
---------------------------
The following are auto-packaging changes to Python and Python 3:
The script-managed ``python-*-manifest.inc`` files that were previously
used to generate Python and Python 3 packages have been replaced with a
JSON-based file that is easier to read and maintain. A new task is
available for maintainers of the Python recipes to update the JSON file
when upgrading to new Python versions. You can now edit the file
directly instead of having to edit a script and run it to update the
file.
One particular change to note is that the Python recipes no longer have
build-time provides for their packages. This assumes ``python-foo`` is
one of the packages provided by the Python recipe. You can no longer run
``bitbake python-foo`` or have a
:term:`DEPENDS` on ``python-foo``,
but doing either of the following causes the package to work as
expected: ::
IMAGE_INSTALL_append = " python-foo"
or ::
RDEPENDS_${PN} = "python-foo"
The earlier build-time provides behavior was a quirk of the
way the Python manifest file was created. For more information on this
change please see `this
commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`__.
.. _migration-2.5-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following are additional changes:
- The ``kernel`` class supports building packages for multiple kernels.
If your kernel recipe or ``.bbappend`` file mentions packaging at
all, you should replace references to the kernel in package names
with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable
automatic installation of the kernel image using
``RDEPENDS_kernel-base = ""`` you can avoid warnings using
``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead.
- The ``buildhistory`` class commits changes to the repository by
default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``.
If you want to disable commits you need to set
``BUILDHISTORY_COMMIT = "0"`` in your configuration.
- The ``beaglebone`` reference machine has been renamed to
``beaglebone-yocto``. The ``beaglebone-yocto`` BSP is a reference
implementation using only mainline components available in
OpenEmbedded-Core and ``meta-yocto-bsp``, whereas Texas Instruments
maintains a full-featured BSP in the ``meta-ti`` layer. This rename
avoids the previous name clash that existed between the two BSPs.
- The ``update-alternatives`` class no longer works with SysV ``init``
scripts because this usage has been problematic. Also, the
``sysklogd`` recipe no longer uses ``update-alternatives`` because it
is incompatible with other implementations.
- By default, the :ref:`cmake <ref-classes-cmake>` class uses
``ninja`` instead of ``make`` for building. This improves build
performance. If a recipe is broken with ``ninja``, then the recipe
can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to
``make``.
- The previously deprecated ``base_*`` functions have been removed in
favor of their replacements in ``meta/lib/oe`` and
``bitbake/lib/bb``. These are typically used from recipes and
classes. Any references to the old functions must be updated. The
following table shows the removed functions and their replacements:
+------------------------------+----------------------------------------------------------+
| *Removed* | *Replacement* |
+==============================+==========================================================+
| base_path_join() | oe.path.join() |
+------------------------------+----------------------------------------------------------+
| base_path_relative() | oe.path.relative() |
+------------------------------+----------------------------------------------------------+
| base_path_out() | oe.path.format_display() |
+------------------------------+----------------------------------------------------------+
| base_read_file() | oe.utils.read_file() |
+------------------------------+----------------------------------------------------------+
| base_ifelse() | oe.utils.ifelse() |
+------------------------------+----------------------------------------------------------+
| base_conditional() | oe.utils.conditional() |
+------------------------------+----------------------------------------------------------+
| base_less_or_equal() | oe.utils.less_or_equal() |
+------------------------------+----------------------------------------------------------+
| base_version_less_or_equal() | oe.utils.version_less_or_equal() |
+------------------------------+----------------------------------------------------------+
| base_contains() | bb.utils.contains() |
+------------------------------+----------------------------------------------------------+
| base_both_contain() | oe.utils.both_contain() |
+------------------------------+----------------------------------------------------------+
| base_prune_suffix() | oe.utils.prune_suffix() |
+------------------------------+----------------------------------------------------------+
| oe_filter() | oe.utils.str_filter() |
+------------------------------+----------------------------------------------------------+
| oe_filter_out() | oe.utils.str_filter_out() (or use the \_remove operator) |
+------------------------------+----------------------------------------------------------+
- Using ``exit 1`` to explicitly defer a postinstall script until first
boot is now deprecated since it is not an obvious mechanism and can
mask actual errors. If you want to explicitly defer a postinstall to
first boot on the target rather than at ``rootfs`` creation time, use
``pkg_postinst_ontarget()`` or call
``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``.
Any failure of a ``pkg_postinst()`` script (including ``exit 1``)
will trigger a warning during ``do_rootfs``.
For more information, see the
":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`"
section in the Yocto Project Development Tasks Manual.
- The ``elf`` image type has been removed. This image type was removed
because the ``mkelfimage`` tool that was required to create it is no
longer provided by coreboot upstream and required updating every time
``binutils`` updated.
- Support for .iso image compression (previously enabled through
``COMPRESSISO = "1"``) has been removed. The userspace tools
(``zisofs-tools``) are unmaintained and ``squashfs`` provides better
performance and compression. In order to build a live image with
squashfs+lz4 compression enabled you should now set
``LIVE_ROOTFS_TYPE = "squashfs-lz4"`` and ensure that ``live`` is in
``IMAGE_FSTYPES``.
- Recipes with an unconditional dependency on ``libpam`` are only
buildable with ``pam`` in ``DISTRO_FEATURES``. If the dependency is
truly optional then it is recommended that the dependency be
conditional upon ``pam`` being in ``DISTRO_FEATURES``.
- For EFI-based machines, the bootloader (``grub-efi`` by default) is
installed into the image at /boot. Wic can be used to split the
bootloader into separate boot and rootfs partitions if necessary.
- Patches whose context does not match exactly (i.e. where patch
reports "fuzz" when applying) will generate a warning. For an example
of this see `this
commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`__.
- Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match
the version(s) of OpenEmbedded-Core they are compatible with. This is
specified as codenames using spaces to separate multiple values (e.g.
"rocko sumo"). If a layer does not set
``LAYERSERIES_COMPAT_layername``, a warning will is shown. If a layer
sets a value that does not include the current version ("sumo" for
the 2.5 release), then an error will be produced.
- The ``TZ`` environment variable is set to "UTC" within the build
environment in order to fix reproducibility problems in some recipes.
documentation/ref-manual/migration-2.6.rst
+476
View File
@@ -0,0 +1,476 @@
Moving to the Yocto Project 2.6 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.6 Release from the prior release.
.. _migration-2.6-gcc-changes:
GCC 8.2 is Now Used by Default
------------------------------
The GNU Compiler Collection version 8.2 is now used by default for
compilation. For more information on what has changed in the GCC 8.x
release, see https://gcc.gnu.org/gcc-8/changes.html.
If you still need to compile with version 7.x, GCC 7.3 is also provided.
You can select this version by setting the and can be selected by
setting the :term:`GCCVERSION` variable to "7.%" in
your configuration.
.. _migration-2.6-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- *beecrypt*: No longer needed since moving to RPM 4.
- *bigreqsproto*: Replaced by ``xorgproto``.
- *calibrateproto*: Removed in favor of ``xinput``.
- *compositeproto*: Replaced by ``xorgproto``.
- *damageproto*: Replaced by ``xorgproto``.
- *dmxproto*: Replaced by ``xorgproto``.
- *dri2proto*: Replaced by ``xorgproto``.
- *dri3proto*: Replaced by ``xorgproto``.
- *eee-acpi-scripts*: Became obsolete.
- *fixesproto*: Replaced by ``xorgproto``.
- *fontsproto*: Replaced by ``xorgproto``.
- *fstests*: Became obsolete.
- *gccmakedep*: No longer used.
- *glproto*: Replaced by ``xorgproto``.
- *gnome-desktop3*: No longer needed. This recipe has moved to ``meta-oe``.
- *icon-naming-utils*: No longer used since the Sato theme was removed in 2016.
- *inputproto*: Replaced by ``xorgproto``.
- *kbproto*: Replaced by ``xorgproto``.
- *libusb-compat*: Became obsolete.
- *libuser*: Became obsolete.
- *libnfsidmap*: No longer an external requirement since ``nfs-utils`` 2.2.1. ``libnfsidmap`` is now integrated.
- *libxcalibrate*: No longer needed with ``xinput``
- *mktemp*: Became obsolete. The ``mktemp`` command is provided by both ``busybox`` and ``coreutils``.
- *ossp-uuid*: Is not being maintained and has mostly been replaced by ``uuid.h`` in ``util-linux``.
- *pax-utils*: No longer needed. Previous QA tests that did use this recipe are now done at build time.
- *pcmciautils*: Became obsolete.
- *pixz*: No longer needed. ``xz`` now supports multi-threaded compression.
- *presentproto*: Replaced by ``xorgproto``.
- *randrproto*: Replaced by ``xorgproto``.
- *recordproto*: Replaced by ``xorgproto``.
- *renderproto*: Replaced by ``xorgproto``.
- *resourceproto*: Replaced by ``xorgproto``.
- *scrnsaverproto*: Replaced by ``xorgproto``.
- *trace-cmd*: Became obsolete. ``perf`` replaced this recipe's functionally.
- *videoproto*: Replaced by ``xorgproto``.
- *wireless-tools*: Became obsolete. Superseded by ``iw``.
- *xcmiscproto*: Replaced by ``xorgproto``.
- *xextproto*: Replaced by ``xorgproto``.
- *xf86dgaproto*: Replaced by ``xorgproto``.
- *xf86driproto*: Replaced by ``xorgproto``.
- *xf86miscproto*: Replaced by ``xorgproto``.
- *xf86-video-omapfb*: Became obsolete. Use kernel modesetting driver instead.
- *xf86-video-omap*: Became obsolete. Use kernel modesetting driver instead.
- *xf86vidmodeproto*: Replaced by ``xorgproto``.
- *xineramaproto*: Replaced by ``xorgproto``.
- *xproto*: Replaced by ``xorgproto``.
- *yasm*: No longer needed since previous usages are now satisfied by ``nasm``.
.. _migration-2.6-packaging-changes:
Packaging Changes
-----------------
The following packaging changes have been made:
- *cmake*: ``cmake.m4`` and ``toolchain`` files have been moved to
the main package.
- *iptables*: The ``iptables`` modules have been split into
separate packages.
- *alsa-lib*: ``libasound`` is now in the main ``alsa-lib`` package
instead of ``libasound``.
- *glibc*: ``libnss-db`` is now in its own package along with a
``/var/db/makedbs.sh`` script to update databases.
- *python and python3*: The main package has been removed from
the recipe. You must install specific packages or ``python-modules``
/ ``python3-modules`` for everything.
- *systemtap*: Moved ``systemtap-exporter`` into its own package.
.. _migration-2.6-xorg-protocol-dependencies:
XOrg Protocol dependencies
--------------------------
The ``*proto`` upstream repositories have been combined into one
"xorgproto" repository. Thus, the corresponding recipes have also been
combined into a single ``xorgproto`` recipe. Any recipes that depend
upon the older ``*proto`` recipes need to be changed to depend on the
newer ``xorgproto`` recipe instead.
For names of recipes removed because of this repository change, see the
`Removed Recipes <#migration-2.6-removed-recipes>`__ section.
.. _migration-2.6-distutils-distutils3-fetching-dependencies:
``distutils`` and ``distutils3`` Now Prevent Fetching Dependencies During the ``do_configure`` Task
---------------------------------------------------------------------------------------------------
Previously, it was possible for Python recipes that inherited the
:ref:`distutils <ref-classes-distutils>` and
:ref:`distutils3 <ref-classes-distutils3>` classes to fetch code
during the :ref:`ref-tasks-configure` task to satisfy
dependencies mentioned in ``setup.py`` if those dependencies were not
provided in the sysroot (i.e. recipes providing the dependencies were
missing from :term:`DEPENDS`).
.. note::
This change affects classes beyond just the two mentioned (i.e.
distutils
and
distutils3
). Any recipe that inherits
distutils\*
classes are affected. For example, the
setuptools
and
setuptools3
recipes are affected since they inherit the
distutils\*
classes.
Fetching these types of dependencies that are not provided in the
sysroot negatively affects the ability to reproduce builds. This type of
fetching is now explicitly disabled. Consequently, any missing
dependencies in Python recipes that use these classes now result in an
error during the ``do_configure`` task.
.. _migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported:
``linux-yocto`` Configuration Audit Issues Now Correctly Reported
-----------------------------------------------------------------
Due to a bug, the kernel configuration audit functionality was not
writing out any resulting warnings during the build. This issue is now
corrected. You might notice these warnings now if you have a custom
kernel configuration with a ``linux-yocto`` style kernel recipe.
.. _migration-2.6-image-kernel-artifact-naming-changes:
Image/Kernel Artifact Naming Changes
------------------------------------
The following changes have been made:
- Name variables (e.g. :term:`IMAGE_NAME`) use a new
``IMAGE_VERSION_SUFFIX`` variable instead of
:term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX``
allows easier and more direct changes.
The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf``
configuration file as follows:
::
IMAGE_VERSION_SUFFIX = "-${DATETIME}"
- Several variables have changed names for consistency:
::
Old Variable Name New Variable Name
========================================================
KERNEL_IMAGE_BASE_NAME :term:`KERNEL_IMAGE_NAME`
KERNEL_IMAGE_SYMLINK_NAME :term:`KERNEL_IMAGE_LINK_NAME`
MODULE_TARBALL_BASE_NAME :term:`MODULE_TARBALL_NAME`
MODULE_TARBALL_SYMLINK_NAME :term:`MODULE_TARBALL_LINK_NAME`
INITRAMFS_BASE_NAME :term:`INITRAMFS_NAME`
- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module
tarball name is now controlled directly with the
:term:`MODULE_TARBALL_NAME` variable.
- The :term:`KERNEL_DTB_NAME` and
:term:`KERNEL_DTB_LINK_NAME` variables
have been introduced to control kernel Device Tree Binary (DTB)
artifact names instead of mangling ``KERNEL_IMAGE_*`` variables.
- The :term:`KERNEL_FIT_NAME` and
:term:`KERNEL_FIT_LINK_NAME` variables
have been introduced to specify the name of flattened image tree
(FIT) kernel images similar to other deployed artifacts.
- The :term:`MODULE_TARBALL_NAME` and
:term:`MODULE_TARBALL_LINK_NAME`
variable values no longer include the "module-" prefix or ".tgz"
suffix. These parts are now hardcoded so that the values are
consistent with other artifact naming variables.
- Added the :term:`INITRAMFS_LINK_NAME`
variable so that the symlink can be controlled similarly to other
artifact types.
- :term:`INITRAMFS_NAME` now uses
"${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" instead
of "${PV}-${PR}-${MACHINE}-${DATETIME}", which makes it consistent
with other variables.
.. _migration-2.6-serial-console-deprecated:
``SERIAL_CONSOLE`` Deprecated
-----------------------------
The :term:`SERIAL_CONSOLE` variable has been
functionally replaced by the
:term:`SERIAL_CONSOLES` variable for some time.
With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been
officially deprecated.
``SERIAL_CONSOLE`` will continue to work as before for the 2.6 release.
However, for the sake of future compatibility, it is recommended that
you replace all instances of ``SERIAL_CONSOLE`` with
``SERIAL_CONSOLES``.
.. note::
The only difference in usage is that
SERIAL_CONSOLES
expects entries to be separated using semicolons as compared to
SERIAL_CONSOLE
, which expects spaces.
.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error:
Configure Script Reports Unknown Options as Errors
--------------------------------------------------
If the configure script reports an unknown option, this now triggers a
QA error instead of a warning. Any recipes that previously got away with
specifying such unknown options now need to be fixed.
.. _migration-2.6-override-changes:
Override Changes
----------------
The following changes have occurred:
- The ``virtclass-native`` and ``virtclass-nativesdk`` Overrides Have
Been Removed: The ``virtclass-native`` and ``virtclass-nativesdk``
overrides have been deprecated since 2012 in favor of
``class-native`` and ``class-nativesdk``, respectively. Both
``virtclass-native`` and ``virtclass-nativesdk`` are now dropped.
.. note::
The
virtclass-multilib-
overrides for multilib are still valid.
- The ``forcevariable`` Override Now Has a Higher Priority Than
``libc`` Overrides: The ``forcevariable`` override is documented to
be the highest priority override. However, due to a long-standing
quirk of how :term:`OVERRIDES` is set, the ``libc``
overrides (e.g. ``libc-glibc``, ``libc-musl``, and so forth)
erroneously had a higher priority. This issue is now corrected.
It is likely this change will not cause any problems. However, it is
possible with some unusual configurations that you might see a change
in behavior if you were relying on the previous behavior. Be sure to
check how you use ``forcevariable`` and ``libc-*`` overrides in your
custom layers and configuration files to ensure they make sense.
- The ``build-${BUILD_OS}`` Override Has Been Removed: The
``build-${BUILD_OS}``, which is typically ``build-linux``, override
has been removed because building on a host operating system other
than a recent version of Linux is neither supported nor recommended.
Dropping the override avoids giving the impression that other host
operating systems might be supported.
- The "_remove" operator now preserves whitespace. Consequently, when
specifying list items to remove, be aware that leading and trailing
whitespace resulting from the removal is retained.
See the ":ref:`bitbake:removing-override-style-syntax`"
section in the BitBake User Manual for a detailed example.
.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf:
``systemd`` Configuration is Now Split Into ``systemd-conf``
------------------------------------------------------------
The configuration for the ``systemd`` recipe has been moved into a
``system-conf`` recipe. Moving this configuration to a separate recipe
avoids the ``systemd`` recipe from becoming machine-specific for cases
where machine-specific configurations need to be applied (e.g. for
``qemu*`` machines).
Currently, the new recipe packages the following files:
::
${sysconfdir}/machine-id
${sysconfdir}/systemd/coredump.conf
${sysconfdir}/systemd/journald.conf
${sysconfdir}/systemd/logind.conf
${sysconfdir}/systemd/system.conf
${sysconfdir}/systemd/user.conf
If you previously used bbappend files to append the ``systemd`` recipe to
change any of the listed files, you must do so for the ``systemd-conf``
recipe instead.
.. _migration-2.6-automatic-testing-changes:
Automatic Testing Changes
-------------------------
This section provides information about automatic testing changes:
- ``TEST_IMAGE`` Variable Removed: Prior to this release, you set the
``TEST_IMAGE`` variable to "1" to enable automatic testing for
successfully built images. The ``TEST_IMAGE`` variable no longer
exists and has been replaced by the
:term:`TESTIMAGE_AUTO` variable.
- Inheriting the ``testimage`` and ``testsdk`` Classes: Best
practices now dictate that you use the
:term:`IMAGE_CLASSES` variable rather than the
:term:`INHERIT` variable when you inherit the
:ref:`testimage <ref-classes-testimage*>` and
:ref:`testsdk <ref-classes-testsdk>` classes used for automatic
testing.
.. _migration-2.6-openssl-changes:
OpenSSL Changes
---------------
`OpenSSL <https://www.openssl.org/>`__ has been upgraded from 1.0 to
1.1. By default, this upgrade could cause problems for recipes that have
both versions in their dependency chains. The problem is that both
versions cannot be installed together at build time.
.. note::
It is possible to have both versions of the library at runtime.
.. _migration-2.6-bitbake-changes:
BitBake Changes
---------------
The server logfile ``bitbake-cookerdaemon.log`` is now always placed in
the :term:`Build Directory` instead of the current
directory.
.. _migration-2.6-security-changes:
Security Changes
----------------
The Poky distribution now uses security compiler flags by default.
Inclusion of these flags could cause new failures due to stricter
checking for various potential security issues in code.
.. _migration-2.6-post-installation-changes:
Post Installation Changes
-------------------------
You must explicitly mark post installs to defer to the target. If you
want to explicitly defer a postinstall to first boot on the target
rather than at rootfs creation time, use ``pkg_postinst_ontarget()`` or
call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``.
Any failure of a ``pkg_postinst()`` script (including exit 1) triggers
an error during the :ref:`ref-tasks-rootfs` task.
For more information on post-installation behavior, see the
":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`"
section in the Yocto Project Development Tasks Manual.
.. _migration-2.6-python-3-profile-guided-optimizations:
Python 3 Profile-Guided Optimization
------------------------------------
The ``python3`` recipe now enables profile-guided optimization. Using
this optimization requires a little extra build time in exchange for
improved performance on the target at runtime. Additionally, the
optimization is only enabled if the current
:term:`MACHINE` has support for user-mode emulation in
QEMU (i.e. "qemu-usermode" is in
:term:`MACHINE_FEATURES`, which it is by
default).
If you wish to disable Python profile-guided optimization regardless of
the value of ``MACHINE_FEATURES``, then ensure that
:term:`PACKAGECONFIG` for the ``python3`` recipe
does not contain "pgo". You could accomplish the latter using the
following at the configuration level:
::
PACKAGECONFIG_remove_pn-python3 = "pgo"
Alternatively, you can set ``PACKAGECONFIG`` using an append file
for the ``python3`` recipe.
.. _migration-2.6-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes occurred:
- Default to using the Thumb-2 instruction set for armv7a and above. If
you have any custom recipes that build software that needs to be
built with the ARM instruction set, change the recipe to set the
instruction set as follows:
::
ARM_INSTRUCTION_SET = "arm"
- ``run-postinsts`` no longer uses ``/etc/*-postinsts`` for
``dpkg/opkg`` in favor of built-in postinst support. RPM behavior
remains unchanged.
- The ``NOISO`` and ``NOHDD`` variables are no longer used. You now
control building ``*.iso`` and ``*.hddimg`` image types directly by
using the :term:`IMAGE_FSTYPES` variable.
- The ``scripts/contrib/mkefidisk.sh`` has been removed in favor of
Wic.
- ``kernel-modules`` has been removed from
:term:`RRECOMMENDS` for ``qemumips`` and
``qemumips64`` machines. Removal also impacts the ``x86-base.inc``
file.
.. note::
genericx86
and
genericx86-64
retain
kernel-modules
as part of the
RRECOMMENDS
variable setting.
- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you
are setting this variable in your configuration, set or append it to
the ``WHITELIST_GPL-3.0`` variable instead.
- ``${ASNEEDED}`` is now included in the
:term:`TARGET_LDFLAGS` variable directly. The
remaining definitions from ``meta/conf/distro/include/as-needed.inc``
have been moved to corresponding recipes.
- Support for DSA host keys has been dropped from the OpenSSH recipes.
If you are still using DSA keys, you must switch over to a more
secure algorithm as recommended by OpenSSH upstream.
- The ``dhcp`` recipe now uses the ``dhcpd6.conf`` configuration file
in ``dhcpd6.service`` for IPv6 DHCP rather than re-using
``dhcpd.conf``, which is now reserved for IPv4.
documentation/ref-manual/migration-2.7.rst
+180
View File
@@ -0,0 +1,180 @@
Moving to the Yocto Project 2.7 Release
=======================================
This section provides migration information for moving to the Yocto
Project 2.7 Release from the prior release.
.. _migration-2.7-bitbake-changes:
BitBake Changes
---------------
The following changes have been made to BitBake:
- BitBake now checks anonymous Python functions and pure Python
functions (e.g. ``def funcname:``) in the metadata for tab
indentation. If found, BitBake produces a warning.
- Bitbake now checks
:term:`BBFILE_COLLECTIONS` for duplicate
entries and triggers an error if any are found.
.. _migration-2.7-eclipse-support-dropped:
Eclipse Support Removed
-----------------------
Support for the Eclipse IDE has been removed. Support continues for
those releases prior to 2.7 that did include support. The 2.7 release
does not include the Eclipse Yocto plugin.
.. _migration-2.7-qemu-native-splits-system-and-user-mode-parts:
``qemu-native`` Splits the System and User-Mode Parts
-----------------------------------------------------
The system and user-mode parts of ``qemu-native`` are now split.
``qemu-native`` provides the user-mode components and
``qemu-system-native`` provides the system components. If you have
recipes that depend on QEMU's system emulation functionality at build
time, they should now depend upon ``qemu-system-native`` instead of
``qemu-native``.
.. _migration-2.7-upstream-tracking.inc-removed:
The ``upstream-tracking.inc`` File Has Been Removed
---------------------------------------------------
The previously deprecated ``upstream-tracking.inc`` file is now removed.
Any ``UPSTREAM_TRACKING*`` variables are now set in the corresponding
recipes instead.
Remove any references you have to the ``upstream-tracking.inc`` file in
your configuration.
.. _migration-2.7-distro-features-libc-removed:
The ``DISTRO_FEATURES_LIBC`` Variable Has Been Removed
------------------------------------------------------
The ``DISTRO_FEATURES_LIBC`` variable is no longer used. The ability to
configure glibc using kconfig has been removed for quite some time
making the ``libc-*`` features set no longer effective.
Remove any references you have to ``DISTRO_FEATURES_LIBC`` in your own
layers.
.. _migration-2.7-license-values:
License Value Corrections
-------------------------
The following corrections have been made to the
:term:`LICENSE` values set by recipes:
- *socat*: Corrected ``LICENSE`` to be "GPLv2" rather than "GPLv2+".
- *libgfortran*: Set license to "GPL-3.0-with-GCC-exception".
- *elfutils*: Removed "Elfutils-Exception" and set to "GPLv2" for shared libraries
.. _migration-2.7-packaging-changes:
Packaging Changes
-----------------
This section provides information about packaging changes.
- ``bind``: The ``nsupdate`` binary has been moved to the
``bind-utils`` package.
- Debug split: The default debug split has been changed to create
separate source packages (i.e. package_name\ ``-dbg`` and
package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in
:term:`IMAGE_FEATURES` to bring in debug
symbols and you still need the sources, you must now also add
``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the
target portion of the SDK by default, unless you have set your own
value for :term:`SDKIMAGE_FEATURES` that
does not include ``src-pkgs``.
- Mount all using ``util-linux``: ``/etc/default/mountall`` has moved
into the -mount sub-package.
- Splitting binaries using ``util-linux``: ``util-linux`` now splits
each binary into its own package for fine-grained control. The main
``util-linux`` package pulls in the individual binary packages using
the :term:`RRECOMMENDS` and
:term:`RDEPENDS` variables. As a result, existing
images should not see any changes assuming
:term:`NO_RECOMMENDATIONS` is not set.
- ``netbase/base-files``: ``/etc/hosts`` has moved from ``netbase`` to
``base-files``.
- ``tzdata``: The main package has been converted to an empty meta
package that pulls in all ``tzdata`` packages by default.
- ``lrzsz``: This package has been removed from
``packagegroup-self-hosted`` and
``packagegroup-core-tools-testapps``. The X/Y/ZModem support is less
likely to be needed on modern systems. If you are relying on these
packagegroups to include the ``lrzsz`` package in your image, you now
need to explicitly add the package.
.. _migration-2.7-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed:
- *gcc*: Drop version 7.3 recipes. Version 8.3 now remains.
- *linux-yocto*: Drop versions 4.14 and 4.18 recipes. Versions 4.19 and 5.0 remain.
- *go*: Drop version 1.9 recipes. Versions 1.11 and 1.12 remain.
- *xvideo-tests*: Became obsolete.
- *libart-lgpl*: Became obsolete.
- *gtk-icon-utils-native*: These tools are now provided by gtk+3-native
- *gcc-cross-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
- *gcc-crosssdk-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead.
- *glibc-initial*: Removed because the benefits of having it for site_config are currently outweighed by the cost of building the recipe.
.. _migration-2.7-removed-classes:
Removed Classes
---------------
The following classes have been removed:
- *distutils-tools*: This class was never used.
- *bugzilla.bbclass*: Became obsolete.
- *distrodata*: This functionally has been replaced by a more modern tinfoil-based implementation.
.. _migration-2.7-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes occurred:
- The ``distro`` subdirectory of the Poky repository has been removed
from the top-level ``scripts`` directory.
- Perl now builds for the target using
`perl-cross <http://arsv.github.io/perl-cross/>`_ for better
maintainability and improved build performance. This change should
not present any problems unless you have heavily customized your Perl
recipe.
- ``arm-tunes``: Removed the "-march" option if mcpu is already added.
- ``update-alternatives``: Convert file renames to
:term:`PACKAGE_PREPROCESS_FUNCS`
- ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been
removed.
- :ref:`native <ref-classes-native>` class:
:term:`RDEPENDS` handling has been enabled.
- ``inetutils``: This recipe has rsh disabled.
documentation/ref-manual/migration-3.0.rst
+321
View File
@@ -0,0 +1,321 @@
Moving to the Yocto Project 3.0 Release
=======================================
This section provides migration information for moving to the Yocto
Project 3.0 Release from the prior release.
.. _migration-3.0-init-system-selection:
Init System Selection
---------------------
Changing the init system manager previously required setting a number of
different variables. You can now change the manager by setting the
``INIT_MANAGER`` variable and the corresponding include files (i.e.
``conf/distro/include/init-manager-*.conf``). Include files are provided
for four values: "none", "sysvinit", "systemd", and "mdev-busybox". The
default value, "none", for ``INIT_MANAGER`` should allow your current
settings to continue working. However, it is advisable to explicitly set
``INIT_MANAGER``.
.. _migration-3.0-lsb-support-removed:
LSB Support Removed
-------------------
Linux Standard Base (LSB) as a standard is not current, and is not well
suited for embedded applications. Support can be continued in a separate
layer if needed. However, presently LSB support has been removed from
the core.
As a result of this change, the ``poky-lsb`` derivative distribution
configuration that was also used for testing alternative configurations
has been replaced with a ``poky-altcfg`` distribution that has LSB parts
removed.
.. _migration-3.0-removed-recipes:
Removed Recipes
---------------
The following recipes have been removed.
- ``core-image-lsb-dev``: Part of removed LSB support.
- ``core-image-lsb``: Part of removed LSB support.
- ``core-image-lsb-sdk``: Part of removed LSB support.
- ``cve-check-tool``: Functionally replaced by the ``cve-update-db``
recipe and ``cve-check`` class.
- ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is
an adequate and maintained alternative.
- ``gcc-8.3``: Version 8.3 removed. Replaced by 9.2.
- ``gnome-themes-standard``: Only needed by gtk+ 2.x, which has been
removed.
- ``gtk+``: GTK+ 2 is obsolete and has been replaced by gtk+3.
- ``irda-utils``: Has become obsolete. IrDA support has been removed
from the Linux kernel in version 4.17 and later.
- ``libnewt-python``: ``libnewt`` Python support merged into main
``libnewt`` recipe.
- ``libsdl``: Replaced by newer ``libsdl2``.
- ``libx11-diet``: Became obsolete.
- ``libxx86dga``: Removed obsolete client library.
- ``libxx86misc``: Removed. Library is redundant.
- ``linux-yocto``: Version 5.0 removed, which is now redundant (5.2 /
4.19 present).
- ``lsbinitscripts``: Part of removed LSB support.
- ``lsb``: Part of removed LSB support.
- ``lsbtest``: Part of removed LSB support.
- ``openssl10``: Replaced by newer ``openssl`` version 1.1.
- ``packagegroup-core-lsb``: Part of removed LSB support.
- ``python-nose``: Removed the Python 2.x version of the recipe.
- ``python-numpy``: Removed the Python 2.x version of the recipe.
- ``python-scons``: Removed the Python 2.x version of the recipe.
- ``source-highlight``: No longer needed.
- ``stress``: Replaced by ``stress-ng``.
- ``vulkan``: Split into ``vulkan-loader``, ``vulkan-headers``, and
``vulkan-tools``.
- ``weston-conf``: Functionality moved to ``weston-init``.
.. _migration-3.0-packaging-changes:
Packaging Changes
-----------------
The following packaging changes have occurred.
- The `Epiphany <https://en.wikipedia.org/wiki/GNOME_Web>`__ browser
has been dropped from ``packagegroup-self-hosted`` as it has not been
needed inside ``build-appliance-image`` for quite some time and was
causing resource problems.
- ``libcap-ng`` Python support has been moved to a separate
``libcap-ng-python`` recipe to streamline the build process when the
Python bindings are not needed.
- ``libdrm`` now packages the file ``amdgpu.ids`` into a separate
``libdrm-amdgpu`` package.
- ``python3``: The ``runpy`` module is now in the ``python3-core``
package as it is required to support the common "python3 -m" command
usage.
- ``distcc`` now provides separate ``distcc-client`` and
``distcc-server`` packages as typically one or the other are needed,
rather than both.
- ``python*-setuptools`` recipes now separately package the
``pkg_resources`` module in a ``python-pkg-resources`` /
``python3-pkg-resources`` package as the module is useful independent
of the rest of the setuptools package. The main ``python-setuptools``
/ ``python3-setuptools`` package depends on this new package so you
should only need to update dependencies unless you want to take
advantage of the increased granularity.
.. _migration-3.0-cve-checking:
CVE Checking
------------
``cve-check-tool`` has been functionally replaced by a new
``cve-update-db`` recipe and functionality built into the ``cve-check``
class. The result uses NVD JSON data feeds rather than the deprecated
XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring,
and makes other improvements.
Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced
by ``CVE_CHECK_WHITELIST``.
.. _migration-3.0-bitbake-changes:
Bitbake Changes
---------------
The following BitBake changes have occurred.
- ``addtask`` statements now properly validate dependent tasks.
Previously, an invalid task was silently ignored. With this change,
the invalid task generates a warning.
- Other invalid ``addtask`` and ``deltask`` usages now trigger these
warnings: "multiple target tasks arguments with addtask / deltask",
and "multiple before/after clauses".
- The "multiconfig" prefix is now shortened to "mc". "multiconfig" will
continue to work, however it may be removed in a future release.
- The ``bitbake -g`` command no longer generates a
``recipe-depends.dot`` file as the contents (i.e. a reprocessed
version of ``task-depends.dot``) were confusing.
- The ``bb.build.FuncFailed`` exception, previously raised by
``bb.build.exec_func()`` when certain other exceptions have occurred,
has been removed. The real underlying exceptions will be raised
instead. If you have calls to ``bb.build.exec_func()`` in custom
classes or ``tinfoil-using`` scripts, any references to
``bb.build.FuncFailed`` should be cleaned up.
- Additionally, the ``bb.build.exec_func()`` no longer accepts the
"pythonexception" parameter. The function now always raises
exceptions. Remove this argument in any calls to
``bb.build.exec_func()`` in custom classes or scripts.
- The
:term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2`
is no longer used. In the unlikely event that you have any references
to it, they should be removed.
- The ``RunQueueExecuteScenequeue`` and ``RunQueueExecuteTasks`` events
have been removed since setscene tasks are now executed as part of
the normal runqueue. Any event handling code in custom classes or
scripts that handles these two events need to be updated.
- The arguments passed to functions used with
:term:`bitbake:BB_HASHCHECK_FUNCTION`
have changed. If you are using your own custom hash check function,
see
http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725
for details.
- Task specifications in ``BB_TASKDEPDATA`` and class implementations
used in signature generator classes now use "<fn>:<task>" everywhere
rather than the "." delimiter that was being used in some places.
This change makes it consistent with all areas in the code. Custom
signature generator classes and code that reads ``BB_TASKDEPDATA``
need to be updated to use ':' as a separator rather than '.'.
.. _migration-3.0-sanity-checks:
Sanity Checks
-------------
The following sanity check changes occurred.
- :term:`SRC_URI` is now checked for usage of two
problematic items:
- "${PN}" prefix/suffix use - Warnings always appear if ${PN} is
used. You must fix the issue regardless of whether multiconfig or
anything else that would cause prefixing/suffixing to happen.
- Github archive tarballs - these are not guaranteed to be stable.
Consequently, it is likely that the tarballs will be refreshed and
thus the SRC_URI checksums will fail to apply. It is recommended
that you fetch either an official release tarball or a specific
revision from the actual Git repository instead.
Either one of these items now trigger a warning by default. If you
wish to disable this check, remove ``src-uri-bad`` from
:term:`WARN_QA`.
- The ``file-rdeps`` runtime dependency check no longer expands
:term:`RDEPENDS` recursively as there is no mechanism
to ensure they can be fully computed, and thus races sometimes result
in errors either showing up or not. Thus, you might now see errors
for missing runtime dependencies that were previously satisfied
recursively. Here is an example: package A contains a shell script
starting with ``#!/bin/bash`` but has no dependency on bash. However,
package A depends on package B, which does depend on bash. You need
to add the missing dependency or dependencies to resolve the warning.
- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now
triggers an error. The error is triggered because
:term:`DEPENDS` is not a package-specific variable
unlike RDEPENDS. You should set ``DEPENDS`` instead.
- systemd currently does not work well with the musl C library because
only upstream officially supports linking the library with glibc.
Thus, a warning is shown when building systemd in conjunction with
musl.
.. _migration-3.0-miscellaneous-changes:
Miscellaneous Changes
---------------------
The following miscellaneous changes have occurred.
- The ``gnome`` class has been removed because it now does very little.
You should update recipes that previously inherited this class to do
the following: inherit gnomebase gtk-icon-cache gconf mime
- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been
removed. This file was previously deprecated in favor of setting
:term:`KERNEL_DEVICETREE` in any kernel
recipe and only produced a warning. Remove any ``include`` or
``require`` statements pointing to this file.
- :term:`TARGET_CFLAGS`,
:term:`TARGET_CPPFLAGS`,
:term:`TARGET_CXXFLAGS`, and
:term:`TARGET_LDFLAGS` are no longer exported
to the external environment. This change did not require any changes
to core recipes, which is a good indicator that no changes will be
required. However, if for some reason the software being built by one
of your recipes is expecting these variables to be set, then building
the recipe will fail. In such cases, you must either export the
variable or variables in the recipe or change the scripts so that
exporting is not necessary.
- You must change the host distro identifier used in
:term:`NATIVELSBSTRING` to use all lowercase
characters even if it does not contain a version number. This change
is necessary only if you are not using ``uninative`` and
:term:`SANITY_TESTED_DISTROS`.
- In the ``base-files`` recipe, writing the hostname into
``/etc/hosts`` and ``/etc/hostname`` is now done within the main
:ref:`ref-tasks-install` function rather than in the
``do_install_basefilesissue`` function. The reason for the change is
because ``do_install_basefilesissue`` is more easily overridden
without having to duplicate the hostname functionality. If you have
done the latter (e.g. in a ``base-files`` bbappend), then you should
remove it from your customized ``do_install_basefilesissue``
function.
- The ``wic --expand`` command now uses commas to separate "key:value"
pairs rather than hyphens.
.. note::
The wic command-line help is not updated.
You must update any scripts or commands where you use
``wic --expand`` with multiple "key:value" pairs.
- UEFI image variable settings have been moved from various places to a
central ``conf/image-uefi.conf``. This change should not influence
any existing configuration as the ``meta/conf/image-uefi.conf`` in
the core metadata sets defaults that can be overridden in the same
manner as before.
- ``conf/distro/include/world-broken.inc`` has been removed. For cases
where certain recipes need to be disabled when using the musl C
library, these recipes now have ``COMPATIBLE_HOST_libc-musl`` set
with a comment that explains why.
documentation/ref-manual/migration-3.1.rst
+276
View File
@@ -0,0 +1,276 @@
Moving to the Yocto Project 3.1 Release
=======================================
This section provides migration information for moving to the Yocto
Project 3.1 Release from the prior release.
.. _migration-3.1-minimum-system-requirements:
Minimum system requirements
---------------------------
The following versions / requirements of build host components have been
updated:
- gcc 5.0
- python 3.5
- tar 1.28
- ``rpcgen`` is now required on the host (part of the ``libc-dev-bin``
package on Ubuntu, Debian and related distributions, and the
``glibc`` package on RPM-based distributions).
Additionally, the ``makeinfo`` and ``pod2man`` tools are *no longer*
required on the host.
.. _migration-3.1-mpc8315e-rdb-removed:
mpc8315e-rdb machine removed
----------------------------
The MPC8315E-RDB machine is old/obsolete and unobtainable, thus given
the maintenance burden the ``mpc8315e-rdb`` machine configuration that
supported it has been removed in this release. The removal does leave a
gap in official PowerPC reference hardware support; this may change in
future if a suitable machine with accompanying support resources is
found.
.. _migration-3.1-python-2-removed:
Python 2 removed
----------------
Due to the expiration of upstream support in January 2020, support for
Python 2 has now been removed; it is recommended that you use Python 3
instead. If absolutely needed there is a meta-python2 community layer
containing Python 2, related classes and various Python 2-based modules,
however it should not be considered as supported.
.. _migration-3.1-reproducible-builds:
Reproducible builds now enabled by default
------------------------------------------
In order to avoid unnecessary differences in output files (aiding binary
reproducibility), the Poky distribution configuration
(``DISTRO = "poky"``) now inherits the ``reproducible_build`` class by
default.
.. _migration-3.1-ptest-feature-impact:
Impact of ptest feature is now more significant
-----------------------------------------------
The Poky distribution configuration (``DISTRO = "poky"``) enables ptests
by default to enable runtime testing of various components. In this
release, a dependency needed to be added that has resulted in a
significant increase in the number of components that will be built just
when building a simple image such as core-image-minimal. If you do not
need runtime tests enabled for core components, then it is recommended
that you remove "ptest" from
:term:`DISTRO_FEATURES` to save a significant
amount of build time e.g. by adding the following in your configuration:
::
DISTRO_FEATURES_remove = "ptest"
.. _migration-3.1-removed-recipes:
Removed recipes
---------------
The following recipes have been removed:
- ``chkconfig``: obsolete
- ``console-tools``: obsolete
- ``enchant``: replaced by ``enchant2``
- ``foomatic-filters``: obsolete
- ``libidn``: no longer needed, moved to meta-oe
- ``libmodulemd``: replaced by ``libmodulemd-v1``
- ``linux-yocto``: drop 4.19, 5.2 version recipes (5.4 now provided)
- ``nspr``: no longer needed, moved to meta-oe
- ``nss``: no longer needed, moved to meta-oe
- ``python``: Python 2 removed (Python 3 preferred)
- ``python-setuptools``: Python 2 version removed (python3-setuptools
preferred)
- ``sysprof``: no longer needed, moved to meta-oe
- ``texi2html``: obsolete
- ``u-boot-fw-utils``: functionally replaced by ``libubootenv``
.. _migration-3.1-features-check:
features_check class replaces distro_features_check
---------------------------------------------------
The ``distro_features_check`` class has had its functionality expanded,
now supporting ``ANY_OF_MACHINE_FEATURES``,
``REQUIRED_MACHINE_FEATURES``, ``CONFLICT_MACHINE_FEATURES``,
``ANY_OF_COMBINED_FEATURES``, ``REQUIRED_COMBINED_FEATURES``,
``CONFLICT_COMBINED_FEATURES``. As a result the class has now been
renamed to ``features_check``; the ``distro_features_check`` class still
exists but generates a warning and redirects to the new class. In
preparation for a future removal of the old class it is recommended that
you update recipes currently inheriting ``distro_features_check`` to
inherit ``features_check`` instead.
.. _migration-3.1-removed-classes:
Removed classes
---------------
The following classes have been removed:
- ``distutils-base``: moved to meta-python2
- ``distutils``: moved to meta-python2
- ``libc-common``: merged into the glibc recipe as nothing else used
it.
- ``python-dir``: moved to meta-python2
- ``pythonnative``: moved to meta-python2
- ``setuptools``: moved to meta-python2
- ``tinderclient``: dropped as it was obsolete.
.. _migration-3.1-src-uri-checksums:
SRC_URI checksum behaviour
--------------------------
Previously, recipes by tradition included both SHA256 and MD5 checksums
for remotely fetched files in :term:`SRC_URI`, even
though only one is actually mandated. However, the MD5 checksum does not
add much given its inherent weakness; thus when a checksum fails only
the SHA256 sum will now be printed. The md5sum will still be verified if
it is specified.
.. _migration-3.1-npm:
npm fetcher changes
-------------------
The npm fetcher has been completely reworked in this release. The npm
fetcher now only fetches the package source itself and no longer the
dependencies; there is now also an npmsw fetcher which explicitly
fetches the shrinkwrap file and the dependencies. This removes the
slightly awkward ``NPM_LOCKDOWN`` and ``NPM_SHRINKWRAP`` variables which
pointed to local files; the lockdown file is no longer needed at all.
Additionally, the package name in ``npm://`` entries in
:term:`SRC_URI` is now specified using a ``package``
parameter instead of the earlier ``name`` which overlapped with the
generic ``name`` parameter. All recipes using the npm fetcher will need
to be changed as a result.
An example of the new scheme: ::
SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \\
npmsw://${THISDIR}/npm-shrinkwrap.json"
Another example where the sources are fetched from git rather than an npm repository: ::
SRC_URI = "git://github.com/foo/bar.git;protocol=https \
npmsw://${THISDIR}/npm-shrinkwrap.json"
devtool and recipetool have also been updated to match with the npm
fetcher changes. Other than producing working and more complete recipes
for npm sources, there is also a minor change to the command line for
devtool: the ``--fetch-dev`` option has been renamed to ``--npm-dev`` as
it is npm-specific.
.. _migration-3.1-packaging-changes:
Packaging changes
-----------------
- ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is
rarely needed to build modern software - gettext can do most of the
things it used to be needed for. ``intltool`` has also been removed
from ``packagegroup-core-self-hosted`` as it is not needed to for
standard builds.
- git: ``git-am``, ``git-difftool``, ``git-submodule``, and
``git-request-pull`` are no longer perl-based, so are now installed
with the main ``git`` package instead of within ``git-perltools``.
- The ``ldconfig`` binary built as part of glibc has now been moved to
its own ``ldconfig`` package (note no ``glibc-`` prefix). This
package is in the :term:`RRECOMMENDS` of the main
``glibc`` package if ``ldconfig`` is present in
:term:`DISTRO_FEATURES`.
- ``libevent`` now splits each shared library into its own package (as
Debian does). Since these are shared libraries and will be pulled in
through the normal shared library dependency handling, there should
be no impact to existing configurations other than less unnecessary
libraries being installed in some cases.
- linux-firmware now has a new package for ``bcm4366c`` and includes
available NVRAM config files into the ``bcm43340``, ``bcm43362``,
``bcm43430`` and ``bcm4356-pcie`` packages.
- ``harfbuzz`` now splits the new ``libharfbuzz-subset.so`` library
into its own package to reduce the main package size in cases where
``libharfbuzz-subset.so`` is not needed.
.. _migration-3.1-package-qa-warnings:
Additional warnings
-------------------
Warnings will now be shown at ``do_package_qa`` time in the following
circumstances:
- A recipe installs ``.desktop`` files containing ``MimeType`` keys but
does not inherit the new ``mime-xdg`` class
- A recipe installs ``.xml`` files into ``${datadir}/mime/packages``
but does not inherit the ``mime`` class
.. _migration-3.1-x86-live-wic:
``wic`` image type now used instead of ``live`` by default for x86
------------------------------------------------------------------
``conf/machine/include/x86-base.inc`` (inherited by most x86 machine
configurations) now specifies ``wic`` instead of ``live`` by default in
:term:`IMAGE_FSTYPES`. The ``live`` image type will
likely be removed in a future release so it is recommended that you use
``wic`` instead.
.. _migration-3.1-misc:
Miscellaneous changes
---------------------
- The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been
removed in favour of a new ``AVAILABLE_LICENSES`` variable which is
dynamically set based upon license files found in
``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``.
- The tune definition for big-endian microblaze machines is now
``microblaze`` instead of ``microblazeeb``.
- ``newlib`` no longer has built-in syscalls. ``libgloss`` should then
provide the syscalls, ``crt0.o`` and other functions that are no
longer part of ``newlib`` itself. If you are using
``TCLIBC = "newlib"`` this now means that you must link applications
with both ``newlib`` and ``libgloss``, whereas before ``newlib``
would run in many configurations by itself.
documentation/ref-manual/migration-general.rst
+54
View File
@@ -0,0 +1,54 @@
General Migration Considerations
================================
Some considerations are not tied to a specific Yocto Project release.
This section presents information you should consider when migrating to
any new Yocto Project release.
- *Dealing with Customized Recipes*:
Issues could arise if you take
older recipes that contain customizations and simply copy them
forward expecting them to work after you migrate to new Yocto Project
metadata. For example, suppose you have a recipe in your layer that
is a customized version of a core recipe copied from the earlier
release, rather than through the use of an append file. When you
migrate to a newer version of Yocto Project, the metadata (e.g.
perhaps an include file used by the recipe) could have changed in a
way that would break the build. Say, for example, a function is
removed from an include file and the customized recipe tries to call
that function.
You could "forward-port" all your customizations in your recipe so
that everything works for the new release. However, this is not the
optimal solution as you would have to repeat this process with each
new release if changes occur that give rise to problems.
The better solution (where practical) is to use append files
(``*.bbappend``) to capture any customizations you want to make to a
recipe. Doing so, isolates your changes from the main recipe making
them much more manageable. However, sometimes it is not practical to
use an append file. A good example of this is when introducing a
newer or older version of a recipe in another layer.
- *Updating Append Files*:
Since append files generally only contain
your customizations, they often do not need to be adjusted for new
releases. However, if the ``.bbappend`` file is specific to a
particular version of the recipe (i.e. its name does not use the %
wildcard) and the version of the recipe to which it is appending has
changed, then you will at a minimum need to rename the append file to
match the name of the recipe file. A mismatch between an append file
and its corresponding recipe file (``.bb``) will trigger an error
during parsing.
Depending on the type of customization the append file applies, other
incompatibilities might occur when you upgrade. For example, if your
append file applies a patch and the recipe to which it is appending
is updated to a newer version, the patch might no longer apply. If
this is the case and assuming the patch is still needed, you must
modify the patch file so that it does apply.
documentation/ref-manual/migration.rst
+30
View File
@@ -0,0 +1,30 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
******************************************
Migrating to a Newer Yocto Project Release
******************************************
This chapter provides information you can use to migrate work to a newer
Yocto Project release. You can find the same information in the release
notes for a given release.
.. toctree::
migration-general
migration-1.3
migration-1.4
migration-1.5
migration-1.6
migration-1.7
migration-1.8
migration-2.0
migration-2.1
migration-2.2
migration-2.3
migration-2.4
migration-2.5
migration-2.6
migration-2.7
migration-3.0
migration-3.1
documentation/ref-manual/migration.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='migration'>
<title>Migrating to a Newer Yocto Project Release</title>
documentation/ref-manual/ref-classes.rst
+2963
View File
File diff suppressed because it is too large Load Diff
documentation/ref-manual/ref-classes.xml
+82 -1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-classes'>
<title>Classes</title>
@@ -1742,6 +1743,12 @@ This check was removed for YP 2.3 release
</note>
</para></listitem>
-->
<listitem><para><emphasis><filename>unlisted-pkg-lics:</filename></emphasis>
Checks that all declared licenses applying for a package are also
declared on the recipe level (i.e. any license in
<filename>LICENSE_*</filename> should appear in
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>).
</para></listitem>
<listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis>
Checks for dynamic library load paths (rpaths) in the binaries that
by default on a standard system are searched by the linker (e.g.
@@ -1873,8 +1880,82 @@ This check was removed for YP 2.3 release
<para>
The <filename>kernel-fitimage</filename> class provides support to
pack zImages.
pack a kernel Image, device trees and a RAM disk into a single
FIT image. In theory, a FIT image can support any number of kernels,
RAM disks and device-trees.
However, <filename>kernel-fitimage</filename> currently only supports
limited usescases: just one kernel image, an optional RAM disk, and
any number of device tree.
</para>
<para>
To create a FIT image, it is required that
<filename><link linkend='var-KERNEL_CLASSES'>KERNEL_CLASSES</link></filename>
is set to "kernel-fitimage" and
<filename><link linkend='var-KERNEL_IMAGETYPE'>KERNEL_IMAGETYPE</link></filename>
is set to "fitImage".
</para>
<para>
The options for the device tree compiler passed to mkimage -D feature
when creating the FIT image are specified using the
<filename><link linkend='var-UBOOT_MKIMAGE_DTCOPTS'>UBOOT_MKIMAGE_DTCOPTS</link></filename>
variable.
</para>
<para>
Only a single kernel can be added to the FIT image created by
<filename>kernel-fitimage</filename> and the kernel image in FIT is
mandatory.
The address where the kernel image is to be loaded by U-boot is
specified by
<filename><link linkend='var-UBOOT_LOADADDRESS'>UBOOT_LOADADDRESS</link></filename>
and the entrypoint by
<filename><link linkend='var-UBOOT_ENTRYPOINT'>UBOOT_ENTRYPOINT</link></filename>.
</para>
<para>
Multiple device trees can be added to the FIT image created by
<filename>kernel-fitimage</filename> and the device tree is optional.
The address where the device tree is to be loaded by U-boot is
specified by
<filename><link linkend='var-UBOOT_DTBO_LOADADDRESS'>UBOOT_DTBO_LOADADDRESS</link></filename>
for device tree overlays and by
<filename><link linkend='var-UBOOT_DTB_LOADADDRESS'>UBOOT_DTB_LOADADDRESS</link></filename>
for device tree binaries.
</para>
<para>
Only a single RAM disk can be added to the FIT image created by
<filename>kernel-fitimage</filename> and the RAM disk in FIT is
optional.
The address where the RAM disk image is to be loaded by U-boot
is specified by
<filename><link linkend='var-UBOOT_RD_LOADADDRESS'>UBOOT_RD_LOADADDRESS</link></filename>
and the entrypoint by
<filename><link linkend='var-UBOOT_RD_ENTRYPOINT'>UBOOT_RD_ENTRYPOINT</link></filename>.
The ramdisk is added to FIT image when
<filename><link linkend='var-INITRAMFS_IMAGE'>INITRAMFS_IMAGE</link></filename>
is specified.
</para>
<para>
The FIT image generated by <filename>kernel-fitimage</filename> class
is signed when the variables
<filename><link linkend='var-UBOOT_SIGN_ENABLE'>UBOOT_SIGN_ENABLE</link></filename>,
<filename><link linkend='var-UBOOT_MKIMAGE_DTCOPTS'>UBOOT_MKIMAGE_DTCOPTS</link></filename>,
<filename><link linkend='var-UBOOT_SIGN_KEYDIR'>UBOOT_SIGN_KEYDIR</link></filename>
and
<filename><link linkend='var-UBOOT_SIGN_KEYNAME'>UBOOT_SIGN_KEYNAME</link></filename>
are set appropriately.
The default values used for
<filename><link linkend='var-FIT_HASH_ALG'>FIT_HASH_ALG</link></filename>
and
<filename><link linkend='var-FIT_SIGN_ALG'>FIT_SIGN_ALG</link></filename>
in <filename>kernel-fitimage</filename> are "sha256" and "rsa2048"
respectively.
</para>
</section>
<section id='ref-classes-kernel-grub'>
documentation/ref-manual/ref-devtool-reference.rst
+625
View File
@@ -0,0 +1,625 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
***************************
``devtool`` Quick Reference
***************************
The ``devtool`` command-line tool provides a number of features that
help you build, test, and package software. This command is available
alongside the ``bitbake`` command. Additionally, the ``devtool`` command
is a key part of the extensible SDK.
This chapter provides a Quick Reference for the ``devtool`` command. For
more information on how to apply the command when using the extensible
SDK, see the ":doc:`../sdk-manual/sdk-extensible`" chapter in the Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK) manual.
.. _devtool-getting-help:
Getting Help
============
The ``devtool`` command line is organized similarly to Git in that it
has a number of sub-commands for each function. You can run
``devtool --help`` to see all the commands:
::
$ devtool -h
NOTE: Starting bitbake server...
usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] <subcommand> ...
OpenEmbedded development tool
options:
--basepath BASEPATH Base directory of SDK / build directory
--bbpath BBPATH Explicitly specify the BBPATH, rather than getting it from the metadata
-d, --debug Enable debug output
-q, --quiet Print only errors
--color COLOR Colorize output (where COLOR is auto, always, never)
-h, --help show this help message and exit
subcommands:
Beginning work on a recipe:
add Add a new recipe
modify Modify the source for an existing recipe
upgrade Upgrade an existing recipe
Getting information:
status Show workspace status
latest-version Report the latest version of an existing recipe
check-upgrade-status Report upgradability for multiple (or all) recipes
search Search available recipes
Working on a recipe in the workspace:
build Build a recipe
rename Rename a recipe file in the workspace
edit-recipe Edit a recipe file
find-recipe Find a recipe file
configure-help Get help on configure script options
update-recipe Apply changes from external source tree to recipe
reset Remove a recipe from your workspace
finish Finish working on a recipe in your workspace
Testing changes on target:
deploy-target Deploy recipe output files to live target machine
undeploy-target Undeploy recipe output files in live target machine
build-image Build image including workspace recipe packages
Advanced:
create-workspace Set up workspace in an alternative location
extract Extract the source for an existing recipe
sync Synchronize the source tree for an existing recipe
menuconfig Alter build-time configuration for a recipe
import Import exported tar archive into workspace
export Export workspace into a tar archive
other:
selftest-reverse Reverse value (for selftest)
pluginfile Print the filename of this plugin
bbdir Print the BBPATH directory of this plugin
count How many times have this plugin been registered.
multiloaded How many times have this plugin been initialized
Use devtool <subcommand> --help to get help on a specific command
As directed in the general help output, you can
get more syntax on a specific command by providing the command name and
using "--help":
::
$ devtool add --help
NOTE: Starting bitbake server...
usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--version VERSION] [--no-git] [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] [--binary] [--also-native] [--src-subdir SUBDIR] [--mirrors]
[--provides PROVIDES]
[recipename] [srctree] [fetchuri]
Adds a new recipe to the workspace to build a specified source tree. Can optionally fetch a remote URI and unpack it to create the source tree.
arguments:
recipename Name for new recipe to add (just name - no version, path or extension). If not specified, will attempt to auto-detect it.
srctree Path to external source tree. If not specified, a subdirectory of /media/build1/poky/build/workspace/sources will be used.
fetchuri Fetch the specified URI and extract it to create the source tree
options:
-h, --help show this help message and exit
--same-dir, -s Build in same directory as source
--no-same-dir Force build in a separate build directory
--fetch URI, -f URI Fetch the specified URI and extract it to create the source tree (deprecated - pass as positional argument instead)
--npm-dev For npm, also fetch devDependencies
--version VERSION, -V VERSION
Version to use within recipe (PV)
--no-git, -g If fetching source, do not set up source tree as a git repository
--srcrev SRCREV, -S SRCREV
Source revision to fetch if fetching from an SCM such as git (default latest)
--autorev, -a When fetching from a git repository, set SRCREV in the recipe to a floating revision instead of fixed
--srcbranch SRCBRANCH, -B SRCBRANCH
Branch in source repository if fetching from an SCM such as git (default master)
--binary, -b Treat the source tree as something that should be installed verbatim (no compilation, same directory structure). Useful with binary packages e.g. RPMs.
--also-native Also add native variant (i.e. support building recipe for the build host as well as the target machine)
--src-subdir SUBDIR Specify subdirectory within source tree to use
--mirrors Enable PREMIRRORS and MIRRORS for source tree fetching (disable by default).
--provides PROVIDES, -p PROVIDES
Specify an alias for the item provided by the recipe. E.g. virtual/libgl
.. _devtool-the-workspace-layer-structure:
The Workspace Layer Structure
=============================
``devtool`` uses a "Workspace" layer in which to accomplish builds. This
layer is not specific to any single ``devtool`` command but is rather a
common working area used across the tool.
The following figure shows the workspace structure:
.. image:: figures/build-workspace-directory.png
:align: center
:scale: 70%
::
attic - A directory created if devtool believes it must preserve
anything when you run "devtool reset". For example, if you
run "devtool add", make changes to the recipe, and then
run "devtool reset", devtool takes notice that the file has
been changed and moves it into the attic should you still
want the recipe.
README - Provides information on what is in workspace layer and how to
manage it.
.devtool_md5 - A checksum file used by devtool.
appends - A directory that contains *.bbappend files, which point to
external source.
conf - A configuration directory that contains the layer.conf file.
recipes - A directory containing recipes. This directory contains a
folder for each directory added whose name matches that of the
added recipe. devtool places the recipe.bb file
within that sub-directory.
sources - A directory containing a working copy of the source files used
when building the recipe. This is the default directory used
as the location of the source tree when you do not provide a
source tree path. This directory contains a folder for each
set of source files matched to a corresponding recipe.
.. _devtool-adding-a-new-recipe-to-the-workspace:
Adding a New Recipe to the Workspace Layer
==========================================
Use the ``devtool add`` command to add a new recipe to the workspace
layer. The recipe you add should not exist - ``devtool`` creates it for
you. The source files the recipe uses should exist in an external area.
The following example creates and adds a new recipe named ``jackson`` to
a workspace layer the tool creates. The source code built by the recipes
resides in ``/home/user/sources/jackson``:
::
$ devtool add jackson /home/user/sources/jackson
If you add a recipe and the workspace layer does not exist, the command
creates the layer and populates it as described in "`The Workspace Layer
Structure <#devtool-the-workspace-layer-structure>`__" section.
Running ``devtool add`` when the workspace layer exists causes the tool
to add the recipe, append files, and source files into the existing
workspace layer. The ``.bbappend`` file is created to point to the
external source tree.
.. note::
If your recipe has runtime dependencies defined, you must be sure
that these packages exist on the target hardware before attempting to
run your application. If dependent packages (e.g. libraries) do not
exist on the target, your application, when run, will fail to find
those functions. For more information, see the
":ref:`ref-manual/ref-devtool-reference:deploying your software on the target machine`"
section.
By default, ``devtool add`` uses the latest revision (i.e. master) when
unpacking files from a remote URI. In some cases, you might want to
specify a source revision by branch, tag, or commit hash. You can
specify these options when using the ``devtool add`` command:
- To specify a source branch, use the ``--srcbranch`` option:
::
$ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson
In the previous example, you are checking out the DISTRO_NAME_NO_CAP
branch.
- To specify a specific tag or commit hash, use the ``--srcrev``
option:
::
$ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson
$ devtool add --srcrev some_commit_hash /home/user/sources/jackson
The previous examples check out the
DISTRO_REL_TAG tag and the commit associated with the
some_commit_hash hash.
.. note::
If you prefer to use the latest revision every time the recipe is
built, use the options --autorev or -a.
.. _devtool-extracting-the-source-for-an-existing-recipe:
Extracting the Source for an Existing Recipe
============================================
Use the ``devtool extract`` command to extract the source for an
existing recipe. When you use this command, you must supply the root
name of the recipe (i.e. no version, paths, or extensions), and you must
supply the directory to which you want the source extracted.
Additional command options let you control the name of a development
branch into which you can checkout the source and whether or not to keep
a temporary directory, which is useful for debugging.
.. _devtool-synchronizing-a-recipes-extracted-source-tree:
Synchronizing a Recipe's Extracted Source Tree
==============================================
Use the ``devtool sync`` command to synchronize a previously extracted
source tree for an existing recipe. When you use this command, you must
supply the root name of the recipe (i.e. no version, paths, or
extensions), and you must supply the directory to which you want the
source extracted.
Additional command options let you control the name of a development
branch into which you can checkout the source and whether or not to keep
a temporary directory, which is useful for debugging.
.. _devtool-modifying-a-recipe:
Modifying an Existing Recipe
============================
Use the ``devtool modify`` command to begin modifying the source of an
existing recipe. This command is very similar to the
```add`` <#devtool-adding-a-new-recipe-to-the-workspace>`__ command
except that it does not physically create the recipe in the workspace
layer because the recipe already exists in an another layer.
The ``devtool modify`` command extracts the source for a recipe, sets it
up as a Git repository if the source had not already been fetched from
Git, checks out a branch for development, and applies any patches from
the recipe as commits on top. You can use the following command to
checkout the source files:
::
$ devtool modify recipe
Using the above command form, ``devtool`` uses the existing recipe's
:term:`SRC_URI` statement to locate the upstream source,
extracts the source into the default sources location in the workspace.
The default development branch used is "devtool".
.. _devtool-edit-an-existing-recipe:
Edit an Existing Recipe
=======================
Use the ``devtool edit-recipe`` command to run the default editor, which
is identified using the ``EDITOR`` variable, on the specified recipe.
When you use the ``devtool edit-recipe`` command, you must supply the
root name of the recipe (i.e. no version, paths, or extensions). Also,
the recipe file itself must reside in the workspace as a result of the
``devtool add`` or ``devtool upgrade`` commands. However, you can
override that requirement by using the "-a" or "--any-recipe" option.
Using either of these options allows you to edit any recipe regardless
of its location.
.. _devtool-updating-a-recipe:
Updating a Recipe
=================
Use the ``devtool update-recipe`` command to update your recipe with
patches that reflect changes you make to the source files. For example,
if you know you are going to work on some code, you could first use the
```devtool modify`` <#devtool-modifying-a-recipe>`__ command to extract
the code and set up the workspace. After which, you could modify,
compile, and test the code.
When you are satisfied with the results and you have committed your
changes to the Git repository, you can then run the
``devtool update-recipe`` to create the patches and update the recipe:
::
$ devtool update-recipe recipe
If you run the ``devtool update-recipe``
without committing your changes, the command ignores the changes.
Often, you might want to apply customizations made to your software in
your own layer rather than apply them to the original recipe. If so, you
can use the ``-a`` or ``--append`` option with the
``devtool update-recipe`` command. These options allow you to specify
the layer into which to write an append file:
::
$ devtool update-recipe recipe -a base-layer-directory
The ``*.bbappend`` file is created at the
appropriate path within the specified layer directory, which may or may
not be in your ``bblayers.conf`` file. If an append file already exists,
the command updates it appropriately.
.. _devtool-checking-on-the-upgrade-status-of-a-recipe:
Checking on the Upgrade Status of a Recipe
==========================================
Upstream recipes change over time. Consequently, you might find that you
need to determine if you can upgrade a recipe to a newer version.
To check on the upgrade status of a recipe, use the
``devtool check-upgrade-status`` command. The command displays a table
of your current recipe versions, the latest upstream versions, the email
address of the recipe's maintainer, and any additional information such
as commit hash strings and reasons you might not be able to upgrade a
particular recipe.
.. note::
- For the ``oe-core`` layer, recipe maintainers come from the
`maintainers.inc <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`_
file.
- If the recipe is using the :ref:`bitbake:git-fetcher`
rather than a
tarball, the commit hash points to the commit that matches the
recipe's latest version tag.
As with all ``devtool`` commands, you can get help on the individual
command:
::
$ devtool check-upgrade-status -h
NOTE: Starting bitbake server...
usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]]
Prints a table of recipes together with versions currently provided by recipes, and latest upstream versions, when there is a later version available
arguments:
recipe Name of the recipe to report (omit to report upgrade info for all recipes)
options:
-h, --help show this help message and exit
--all, -a Show all recipes, not just recipes needing upgrade
Unless you provide a specific recipe name on the command line, the
command checks all recipes in all configured layers.
Following is a partial example table that reports on all the recipes.
Notice the reported reason for not upgrading the ``base-passwd`` recipe.
In this example, while a new version is available upstream, you do not
want to use it because the dependency on ``cdebconf`` is not easily
satisfied.
.. note::
When a reason for not upgrading displays, the reason is usually
written into the recipe using the RECIPE_NO_UPDATE_REASON
variable. See the base-passwd.bb recipe for an example.
::
$ devtool check-upgrade-status ...
NOTE: acpid 2.0.30 2.0.31 Ross Burton <ross.burton@intel.com>
NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff
NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff . . .
NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility
NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com>
NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com>
.. _devtool-upgrading-a-recipe:
Upgrading a Recipe
==================
As software matures, upstream recipes are upgraded to newer versions. As
a developer, you need to keep your local recipes up-to-date with the
upstream version releases. Several methods exist by which you can
upgrade recipes. You can read about them in the ":ref:`gs-upgrading-recipes`"
section of the Yocto Project Development Tasks Manual. This section
overviews the ``devtool upgrade`` command.
Before you upgrade a recipe, you can check on its upgrade status. See
the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" section
for more information.
The ``devtool upgrade`` command upgrades an existing recipe to a more
recent version of the recipe upstream. The command puts the upgraded
recipe file along with any associated files into a "workspace" and, if
necessary, extracts the source tree to a specified location. During the
upgrade, patches associated with the recipe are rebased or added as
needed.
When you use the ``devtool upgrade`` command, you must supply the root
name of the recipe (i.e. no version, paths, or extensions), and you must
supply the directory to which you want the source extracted. Additional
command options let you control things such as the version number to
which you want to upgrade (i.e. the :term:`PV`), the source
revision to which you want to upgrade (i.e. the
:term:`SRCREV`), whether or not to apply patches, and so
forth.
You can read more on the ``devtool upgrade`` workflow in the
":ref:`sdk-devtool-use-devtool-upgrade-to-create-a-version-of-the-recipe-that-supports-a-newer-version-of-the-software`"
section in the Yocto Project Application Development and the Extensible
Software Development Kit (eSDK) manual. You can also see an example of
how to use ``devtool upgrade`` in the ":ref:`gs-using-devtool-upgrade`"
section in the Yocto Project Development Tasks Manual.
.. _devtool-resetting-a-recipe:
Resetting a Recipe
==================
Use the ``devtool reset`` command to remove a recipe and its
configuration (e.g. the corresponding ``.bbappend`` file) from the
workspace layer. Realize that this command deletes the recipe and the
append file. The command does not physically move them for you.
Consequently, you must be sure to physically relocate your updated
recipe and the append file outside of the workspace layer before running
the ``devtool reset`` command.
If the ``devtool reset`` command detects that the recipe or the append
files have been modified, the command preserves the modified files in a
separate "attic" subdirectory under the workspace layer.
Here is an example that resets the workspace directory that contains the
``mtr`` recipe:
::
$ devtool reset mtr
NOTE: Cleaning sysroot for recipe mtr...
NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually
$
.. _devtool-building-your-recipe:
Building Your Recipe
====================
Use the ``devtool build`` command to build your recipe. The
``devtool build`` command is equivalent to the
``bitbake -c populate_sysroot`` command.
When you use the ``devtool build`` command, you must supply the root
name of the recipe (i.e. do not provide versions, paths, or extensions).
You can use either the "-s" or the "--disable-parallel-make" options to
disable parallel makes during the build. Here is an example:
::
$ devtool build recipe
.. _devtool-building-your-image:
Building Your Image
===================
Use the ``devtool build-image`` command to build an image, extending it
to include packages from recipes in the workspace. Using this command is
useful when you want an image that ready for immediate deployment onto a
device for testing. For proper integration into a final image, you need
to edit your custom image recipe appropriately.
When you use the ``devtool build-image`` command, you must supply the
name of the image. This command has no command line options:
::
$ devtool build-image image
.. _devtool-deploying-your-software-on-the-target-machine:
Deploying Your Software on the Target Machine
=============================================
Use the ``devtool deploy-target`` command to deploy the recipe's build
output to the live target machine:
::
$ devtool deploy-target recipe target
The target is the address of the target machine, which must be running
an SSH server (i.e. ``user@hostname[:destdir]``).
This command deploys all files installed during the
:ref:`ref-tasks-install` task. Furthermore, you do not
need to have package management enabled within the target machine. If
you do, the package manager is bypassed.
.. note::
The ``deploy-target`` functionality is for development only. You
should never use it to update an image that will be used in
production.
Some conditions exist that could prevent a deployed application from
behaving as expected. When both of the following conditions exist, your
application has the potential to not behave correctly when run on the
target:
- You are deploying a new application to the target and the recipe you
used to build the application had correctly defined runtime
dependencies.
- The target does not physically have the packages on which the
application depends installed.
If both of these conditions exist, your application will not behave as
expected. The reason for this misbehavior is because the
``devtool deploy-target`` command does not deploy the packages (e.g.
libraries) on which your new application depends. The assumption is that
the packages are already on the target. Consequently, when a runtime
call is made in the application for a dependent function (e.g. a library
call), the function cannot be found.
To be sure you have all the dependencies local to the target, you need
to be sure that the packages are pre-deployed (installed) on the target
before attempting to run your application.
.. _devtool-removing-your-software-from-the-target-machine:
Removing Your Software from the Target Machine
==============================================
Use the ``devtool undeploy-target`` command to remove deployed build
output from the target machine. For the ``devtool undeploy-target``
command to work, you must have previously used the
":ref:`devtool deploy-target <ref-manual/ref-devtool-reference:deploying your software on the target machine>`"
command.
::
$ devtool undeploy-target recipe target
The target is the
address of the target machine, which must be running an SSH server (i.e.
``user@hostname``).
.. _devtool-creating-the-workspace:
Creating the Workspace Layer in an Alternative Location
=======================================================
Use the ``devtool create-workspace`` command to create a new workspace
layer in your :term:`Build Directory`. When you create a
new workspace layer, it is populated with the ``README`` file and the
``conf`` directory only.
The following example creates a new workspace layer in your current
working and by default names the workspace layer "workspace":
::
$ devtool create-workspace
You can create a workspace layer anywhere by supplying a pathname with
the command. The following command creates a new workspace layer named
"new-workspace":
::
$ devtool create-workspace /home/scottrif/new-workspace
.. _devtool-get-the-status-of-the-recipes-in-your-workspace:
Get the Status of the Recipes in Your Workspace
===============================================
Use the ``devtool status`` command to list the recipes currently in your
workspace. Information includes the paths to their respective external
source trees.
The ``devtool status`` command has no command-line options:
::
$ devtool status
Following is sample output after using
:ref:`devtool add <ref-manual/ref-devtool-reference:adding a new recipe to the workspace layer>`
to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:
::
$ devtool status mtr
:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb)
$
.. _devtool-search-for-available-target-recipes:
Search for Available Target Recipes
===================================
Use the ``devtool search`` command to search for available target
recipes. The command matches the recipe name, package name, description,
and installed files. The command displays the recipe name as a result of
a match.
When you use the ``devtool search`` command, you must supply a keyword.
The command uses the keyword when searching for a match.
documentation/ref-manual/ref-devtool-reference.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-devtool-reference'>
<title><filename>devtool</filename> Quick Reference</title>
documentation/ref-manual/ref-features.rst
+353
View File
@@ -0,0 +1,353 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
********
Features
********
This chapter provides a reference of shipped machine and distro features
you can include as part of your image, a reference on image features you
can select, and a reference on feature backfilling.
Features provide a mechanism for working out which packages should be
included in the generated images. Distributions can select which
features they want to support through the ``DISTRO_FEATURES`` variable,
which is set or appended to in a distribution's configuration file such
as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth.
Machine features are set in the ``MACHINE_FEATURES`` variable, which is
set in the machine configuration file and specifies the hardware
features for a given machine.
These two variables combine to work out which kernel modules, utilities,
and other packages to include. A given distribution can support a
selected subset of features so some machine features might not be
included if the distribution itself does not support them.
One method you can use to determine which recipes are checking to see if
a particular feature is contained or not is to ``grep`` through the
:term:`Metadata` for the feature. Here is an example that
discovers the recipes whose build is potentially changed based on a
given feature:
::
$ cd poky
$ git grep 'contains.*MACHINE_FEATURES.*feature'
.. _ref-features-machine:
Machine Features
================
The items below are features you can use with
:term:`MACHINE_FEATURES`. Features do not have a
one-to-one correspondence to packages, and they can go beyond simply
controlling the installation of a package or packages. Sometimes a
feature can influence how certain recipes are built. For example, a
feature might determine whether a particular configure option is
specified within the :ref:`ref-tasks-configure` task
for a particular recipe.
This feature list only represents features as shipped with the Yocto
Project metadata:
- *acpi:* Hardware has ACPI (x86/x86_64 only)
- *alsa:* Hardware has ALSA audio drivers
- *apm:* Hardware uses APM (or APM emulation)
- *bluetooth:* Hardware has integrated BT
- *efi:* Support for booting through EFI
- *ext2:* Hardware HDD or Microdrive
- *keyboard:* Hardware has a keyboard
- *pcbios:* Support for booting through BIOS
- *pci:* Hardware has a PCI bus
- *pcmcia:* Hardware has PCMCIA or CompactFlash sockets
- *phone:* Mobile phone (voice) support
- *qvga:* Machine has a QVGA (320x240) display
- *rtc:* Machine has a Real-Time Clock
- *screen:* Hardware has a screen
- *serial:* Hardware has serial support (usually RS232)
- *touchscreen:* Hardware has a touchscreen
- *usbgadget:* Hardware is USB gadget device capable
- *usbhost:* Hardware is USB Host capable
- *vfat:* FAT file system support
- *wifi:* Hardware has integrated WiFi
.. _ref-features-distro:
Distro Features
===============
The items below are features you can use with
:term:`DISTRO_FEATURES` to enable features across
your distribution. Features do not have a one-to-one correspondence to
packages, and they can go beyond simply controlling the installation of
a package or packages. In most cases, the presence or absence of a
feature translates to the appropriate option supplied to the configure
script during the :ref:`ref-tasks-configure` task for
the recipes that optionally support the feature.
Some distro features are also machine features. These select features
make sense to be controlled both at the machine and distribution
configuration level. See the
:term:`COMBINED_FEATURES` variable for more
information.
This list only represents features as shipped with the Yocto Project
metadata:
- *alsa:* Include ALSA support (OSS compatibility kernel modules
installed if available).
- *api-documentation:* Enables generation of API documentation during
recipe builds. The resulting documentation is added to SDK tarballs
when the ``bitbake -c populate_sdk`` command is used. See the
":ref:`sdk-manual/sdk-appendix-customizing-standard:adding api documentation to the standard sdk`"
section in the Yocto Project Application Development and the
Extensible Software Development Kit (eSDK) manual.
- *bluetooth:* Include bluetooth support (integrated BT only).
- *cramfs:* Include CramFS support.
- *directfb:* Include DirectFB support.
- *ext2:* Include tools for supporting for devices with internal
HDD/Microdrive for storing files (instead of Flash only devices).
- *ipsec:* Include IPSec support.
- *ipv6:* Include IPv6 support.
- *keyboard:* Include keyboard support (e.g. keymaps will be loaded
during boot).
- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the
target.
- *nfs:* Include NFS client support (for mounting NFS exports on
device).
- *opengl:* Include the Open Graphics Library, which is a
cross-language, multi-platform application programming interface used
for rendering two and three-dimensional graphics.
- *pci:* Include PCI bus support.
- *pcmcia:* Include PCMCIA/CompactFlash support.
- *ppp:* Include PPP dialup support.
- *ptest:* Enables building the package tests where supported by
individual recipes. For more information on package tests, see the
":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" section
in the Yocto Project Development Tasks Manual.
- *smbfs:* Include SMB networks client support (for mounting
Samba/Microsoft Windows shares on device).
- *systemd:* Include support for this ``init`` manager, which is a full
replacement of for ``init`` with parallel starting of services,
reduced shell overhead, and other features. This ``init`` manager is
used by many distributions.
- *usbgadget:* Include USB Gadget Device support (for USB
networking/serial/storage).
- *usbhost:* Include USB Host support (allows to connect external
keyboard, mouse, storage, network etc).
- *usrmerge:* Merges the ``/bin``, ``/sbin``, ``/lib``, and ``/lib64``
directories into their respective counterparts in the ``/usr``
directory to provide better package and application compatibility.
- *wayland:* Include the Wayland display server protocol and the
library that supports it.
- *wifi:* Include WiFi support (integrated only).
- *x11:* Include the X server and libraries.
.. _ref-features-image:
Image Features
==============
The contents of images generated by the OpenEmbedded build system can be
controlled by the :term:`IMAGE_FEATURES` and
:term:`EXTRA_IMAGE_FEATURES` variables that
you typically configure in your image recipes. Through these variables,
you can add several different predefined packages such as development
utilities or packages with debug information needed to investigate
application problems or profile applications.
The following image features are available for all images:
- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root
logins and logins from accounts having an empty password string.
- *dbg-pkgs:* Installs debug symbol packages for all packages installed
in a given image.
- *debug-tweaks:* Makes an image suitable for development (e.g. allows
root logins without passwords and enables post-installation logging).
See the 'allow-empty-password', 'empty-root-password', and
'post-install-logging' features in this list for additional
information.
- *dev-pkgs:* Installs development packages (headers and extra library
links) for all packages installed in a given image.
- *doc-pkgs:* Installs documentation packages for all packages
installed in a given image.
- *empty-root-password:* Sets the root password to an empty string,
which allows logins with a blank password.
- *package-management:* Installs package management tools and preserves
the package manager database.
- *post-install-logging:* Enables logging postinstall script runs to
the ``/var/log/postinstall.log`` file on first boot of the image on
the target system.
.. note::
To make the
/var/log
directory on the target persistent, use the
VOLATILE_LOG_DIR
variable by setting it to "no".
- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
- *read-only-rootfs:* Creates an image whose root filesystem is
read-only. See the
":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`"
section in the Yocto Project Development Tasks Manual for more
information.
- *splash:* Enables showing a splash screen during boot. By default,
this screen is provided by ``psplash``, which does allow
customization. If you prefer to use an alternative splash screen
package, you can do so by setting the ``SPLASH`` variable to a
different package name (or names) within the image recipe or at the
distro configuration level.
- *staticdev-pkgs:* Installs static development packages, which are
static libraries (i.e. ``*.a`` files), for all packages installed in
a given image.
Some image features are available only when you inherit the
:ref:`core-image <ref-classes-core-image>` class. The current list of
these valid features is as follows:
- *hwcodecs:* Installs hardware acceleration codecs.
- *nfs-server:* Installs an NFS server.
- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
``LTTng``. For general information on user-space tools, see the
:doc:`../sdk-manual/sdk-manual` manual.
- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
- *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more
full-featured than Dropbear. Note that if both the OpenSSH SSH server
and the Dropbear minimal SSH server are present in
``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear
will not be installed.
- *tools-debug:* Installs debugging tools such as ``strace`` and
``gdb``. For information on GDB, see the
":ref:`platdev-gdb-remotedebug`" section
in the Yocto Project Development Tasks Manual. For information on
tracing and profiling, see the :doc:`../profile-manual/profile-manual`.
- *tools-sdk:* Installs a full SDK that runs on the device.
- *tools-testapps:* Installs device testing tools (e.g. touchscreen
debugging).
- *x11:* Installs the X server.
- *x11-base:* Installs the X server with a minimal environment.
- *x11-sato:* Installs the OpenedHand Sato environment.
.. _ref-features-backfill:
Feature Backfilling
===================
Sometimes it is necessary in the OpenEmbedded build system to extend
:term:`MACHINE_FEATURES` or
:term:`DISTRO_FEATURES` to control functionality
that was previously enabled and not able to be disabled. For these
cases, we need to add an additional feature item to appear in one of
these variables, but we do not want to force developers who have
existing values of the variables in their configuration to add the new
feature in order to retain the same overall level of functionality.
Thus, the OpenEmbedded build system has a mechanism to automatically
"backfill" these added features into existing distro or machine
configurations. You can see the list of features for which this is done
by finding the
:term:`DISTRO_FEATURES_BACKFILL` and
:term:`MACHINE_FEATURES_BACKFILL`
variables in the ``meta/conf/bitbake.conf`` file.
Because such features are backfilled by default into all configurations
as described in the previous paragraph, developers who wish to disable
the new features need to be able to selectively prevent the backfilling
from occurring. They can do this by adding the undesired feature or
features to the
:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
or
:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
variables for distro features and machine features respectively.
Here are two examples to help illustrate feature backfilling:
- *The "pulseaudio" distro feature option*: Previously, PulseAudio
support was enabled within the Qt and GStreamer frameworks. Because
of this, the feature is backfilled and thus enabled for all distros
through the ``DISTRO_FEATURES_BACKFILL`` variable in the
``meta/conf/bitbake.conf`` file. However, your distro needs to
disable the feature. You can disable the feature without affecting
other existing distro configurations that need PulseAudio support by
adding "pulseaudio" to ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in
your distro's ``.conf`` file. Adding the feature to this variable
when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable
prevents the build system from adding the feature to your
configuration's ``DISTRO_FEATURES``, effectively disabling the
feature for that particular distro.
- *The "rtc" machine feature option*: Previously, real time clock (RTC)
support was enabled for all target devices. Because of this, the
feature is backfilled and thus enabled for all machines through the
``MACHINE_FEATURES_BACKFILL`` variable in the
``meta/conf/bitbake.conf`` file. However, your target device does not
have this capability. You can disable RTC support for your device
without affecting other machines that need RTC support by adding the
feature to your machine's ``MACHINE_FEATURES_BACKFILL_CONSIDERED``
list in the machine's ``.conf`` file. Adding the feature to this
variable when it also exists in the ``MACHINE_FEATURES_BACKFILL``
variable prevents the build system from adding the feature to your
configuration's ``MACHINE_FEATURES``, effectively disabling RTC
support for that particular machine.
documentation/ref-manual/ref-features.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-features'>
<title>Features</title>
documentation/ref-manual/ref-images.rst
+139
View File
@@ -0,0 +1,139 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
******
Images
******
The OpenEmbedded build system provides several example images to satisfy
different needs. When you issue the ``bitbake`` command you provide a
"top-level" recipe that essentially begins the build for the type of
image you want.
.. note::
Building an image without GNU General Public License Version 3
(GPLv3), GNU Lesser General Public License Version 3 (LGPLv3), and
the GNU Affero General Public License Version 3 (AGPL-3.0) components
is only supported for minimal and base images. Furthermore, if you
are going to build an image using non-GPLv3 and similarly licensed
components, you must make the following changes in the
local.conf
file before using the BitBake command to build the minimal or base
image:
::
1. Comment out the EXTRA_IMAGE_FEATURES line
2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0"
From within the ``poky`` Git repository, you can use the following
command to display the list of directories within the :term:`Source Directory`
that contain image recipe files: ::
$ ls meta*/recipes*/images/*.bb
Following is a list of supported recipes:
- ``build-appliance-image``: An example virtual machine that contains
all the pieces required to run builds using the build system as well
as the build system itself. You can boot and run the image using
either the `VMware
Player <http://www.vmware.com/products/player/overview.html>`__ or
`VMware
Workstation <http://www.vmware.com/products/workstation/overview.html>`__.
For more information on this image, see the :yocto_home:`Build
Appliance </software-item/build-appliance>` page
on the Yocto Project website.
- ``core-image-base``: A console-only image that fully supports the
target device hardware.
- ``core-image-clutter``: An image with support for the Open GL-based
toolkit Clutter, which enables development of rich and animated
graphical user interfaces.
- ``core-image-full-cmdline``: A console-only image with more
full-featured Linux system functionality installed.
- ``core-image-lsb``: An image that conforms to the Linux Standard Base
(LSB) specification. This image requires a distribution configuration
that enables LSB compliance (e.g. ``poky-lsb``). If you build
``core-image-lsb`` without that configuration, the image will not be
LSB-compliant.
- ``core-image-lsb-dev``: A ``core-image-lsb`` image that is suitable
for development work using the host. The image includes headers and
libraries you can use in a host development environment. This image
requires a distribution configuration that enables LSB compliance
(e.g. ``poky-lsb``). If you build ``core-image-lsb-dev`` without that
configuration, the image will not be LSB-compliant.
- ``core-image-lsb-sdk``: A ``core-image-lsb`` that includes everything
in the cross-toolchain but also includes development headers and
libraries to form a complete standalone SDK. This image requires a
distribution configuration that enables LSB compliance (e.g.
``poky-lsb``). If you build ``core-image-lsb-sdk`` without that
configuration, the image will not be LSB-compliant. This image is
suitable for development using the target.
- ``core-image-minimal``: A small image just capable of allowing a
device to boot.
- ``core-image-minimal-dev``: A ``core-image-minimal`` image suitable
for development work using the host. The image includes headers and
libraries you can use in a host development environment.
- ``core-image-minimal-initramfs``: A ``core-image-minimal`` image that
has the Minimal RAM-based Initial Root Filesystem (initramfs) as part
of the kernel, which allows the system to find the first "init"
program more efficiently. See the
:term:`PACKAGE_INSTALL` variable for
additional information helpful when working with initramfs images.
- ``core-image-minimal-mtdutils``: A ``core-image-minimal`` image that
has support for the Minimal MTD Utilities, which let the user
interact with the MTD subsystem in the kernel to perform operations
on flash devices.
- ``core-image-rt``: A ``core-image-minimal`` image plus a real-time
test suite and tools appropriate for real-time use.
- ``core-image-rt-sdk``: A ``core-image-rt`` image that includes
everything in the cross-toolchain. The image also includes
development headers and libraries to form a complete stand-alone SDK
and is suitable for development using the target.
- ``core-image-sato``: An image with Sato support, a mobile environment
and visual style that works well with mobile devices. The image
supports X11 with a Sato theme and applications such as a terminal,
editor, file manager, media player, and so forth.
- ``core-image-sato-dev``: A ``core-image-sato`` image suitable for
development using the host. The image includes libraries needed to
build applications on the device itself, testing and profiling tools,
and debug symbols. This image was formerly ``core-image-sdk``.
- ``core-image-sato-sdk``: A ``core-image-sato`` image that includes
everything in the cross-toolchain. The image also includes
development headers and libraries to form a complete standalone SDK
and is suitable for development using the target.
- ``core-image-testmaster``: A "master" image designed to be used for
automated runtime testing. Provides a "known good" image that is
deployed to a separate partition so that you can boot into it and use
it to deploy a second image to be tested. You can find more
information about runtime testing in the
":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual.
- ``core-image-testmaster-initramfs``: A RAM-based Initial Root
Filesystem (initramfs) image tailored for use with the
``core-image-testmaster`` image.
- ``core-image-weston``: A very basic Wayland image with a terminal.
This image provides the Wayland protocol libraries and the reference
Weston compositor. For more information, see the
":ref:`dev-manual/dev-manual-common-tasks:using wayland and weston`"
section in the Yocto Project Development Tasks Manual.
- ``core-image-x11``: A very basic X11 image with a terminal.
documentation/ref-manual/ref-images.xml
+3 -2
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-images'>
<title>Images</title>
@@ -8,7 +9,7 @@
<para>
The OpenEmbedded build system provides several example
images to satisfy different needs.
When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
When you issue the <filename>bitbake</filename> command you provide a "top-level" recipe
that essentially begins the build for the type of image you want.
</para>
@@ -99,7 +100,7 @@
<listitem><para id='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename>:
A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
Initial Root Filesystem (initramfs) as part of the kernel,
which allows the system to find the first “init” program more efficiently.
which allows the system to find the first "init" program more efficiently.
See the
<link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
variable for additional information helpful when working with
documentation/ref-manual/ref-kickstart.rst
+212
View File
@@ -0,0 +1,212 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*******************************************
OpenEmbedded Kickstart (``.wks``) Reference
*******************************************
.. _openembedded-kickstart-wks-reference:
Introduction
============
The current Wic implementation supports only the basic kickstart
partitioning commands: ``partition`` (or ``part`` for short) and
``bootloader``.
.. note::
Future updates will implement more commands and options. If you use
anything that is not specifically supported, results can be
unpredictable.
This chapter provides a reference on the available kickstart commands.
The information lists the commands, their syntax, and meanings.
Kickstart commands are based on the Fedora kickstart versions but with
modifications to reflect Wic capabilities. You can see the original
documentation for those commands at the following link:
http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html
Command: part or partition
==========================
Either of these commands creates a partition on the system and uses the
following syntax:
::
part [mntpoint]
partition [mntpoint]
If you do not
provide mntpoint, Wic creates a partition but does not mount it.
The ``mntpoint`` is where the partition is mounted and must be in one of
the following forms:
- ``/path``: For example, "/", "/usr", or "/home"
- ``swap``: The created partition is used as swap space
Specifying a mntpoint causes the partition to automatically be mounted.
Wic achieves this by adding entries to the filesystem table (fstab)
during image generation. In order for Wic to generate a valid fstab, you
must also provide one of the ``--ondrive``, ``--ondisk``, or
``--use-uuid`` partition options as part of the command.
.. note::
The mount program must understand the PARTUUID syntax you use with
--use-uuid
and non-root
mountpoint
, including swap. The busybox versions of these application are
currently excluded.
Here is an example that uses "/" as the mountpoint. The command uses
``--ondisk`` to force the partition onto the ``sdb`` disk: part /
--source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
Here is a list that describes other supported options you can use with
the ``part`` and ``partition`` commands:
- ``--size``: The minimum partition size in MBytes. Specify an
integer value such as 500. Do not append the number with "MB". You do
not need this option if you use ``--source``.
- ``--fixed-size``: The exact partition size in MBytes. You cannot
specify with ``--size``. An error occurs when assembling the disk
image if the partition data is larger than ``--fixed-size``.
- ``--source``: This option is a Wic-specific option that names the
source of the data that populates the partition. The most common
value for this option is "rootfs", but you can use any value that
maps to a valid source plugin. For information on the source plugins,
see the ":ref:`dev-manual/dev-manual-common-tasks:using the wic plugin interface`"
section in the Yocto Project Development Tasks Manual.
If you use ``--source rootfs``, Wic creates a partition as large as
needed and fills it with the contents of the root filesystem pointed
to by the ``-r`` command-line option or the equivalent rootfs derived
from the ``-e`` command-line option. The filesystem type used to
create the partition is driven by the value of the ``--fstype``
option specified for the partition. See the entry on ``--fstype``
that follows for more information.
If you use ``--source plugin-name``, Wic creates a partition as large
as needed and fills it with the contents of the partition that is
generated by the specified plugin name using the data pointed to by
the ``-r`` command-line option or the equivalent rootfs derived from
the ``-e`` command-line option. Exactly what those contents are and
filesystem type used are dependent on the given plugin
implementation.
If you do not use the ``--source`` option, the ``wic`` command
creates an empty partition. Consequently, you must use the ``--size``
option to specify the size of the empty partition.
- ``--ondisk`` or ``--ondrive``: Forces the partition to be created
on a particular disk.
- ``--fstype``: Sets the file system type for the partition. Valid
values are:
- ``ext4``
- ``ext3``
- ``ext2``
- ``btrfs``
- ``squashfs``
- ``swap``
- ``--fsoptions``: Specifies a free-form string of options to be used
when mounting the filesystem. This string is copied into the
``/etc/fstab`` file of the installed system and should be enclosed in
quotes. If not specified, the default string is "defaults".
- ``--label label``: Specifies the label to give to the filesystem to
be made on the partition. If the given label is already in use by
another filesystem, a new label is created for the partition.
- ``--active``: Marks the partition as active.
- ``--align (in KBytes)``: This option is a Wic-specific option that
says to start partitions on boundaries given x KBytes.
- ``--no-table``: This option is a Wic-specific option. Using the
option reserves space for the partition and causes it to become
populated. However, the partition is not added to the partition
table.
- ``--exclude-path``: This option is a Wic-specific option that
excludes the given relative path from the resulting image. This
option is only effective with the rootfs source plugin.
- ``--extra-space``: This option is a Wic-specific option that adds
extra space after the space filled by the content of the partition.
The final size can exceed the size specified by the ``--size``
option. The default value is 10 Mbytes.
- ``--overhead-factor``: This option is a Wic-specific option that
multiplies the size of the partition by the option's value. You must
supply a value greater than or equal to "1". The default value is
"1.3".
- ``--part-name``: This option is a Wic-specific option that
specifies a name for GPT partitions.
- ``--part-type``: This option is a Wic-specific option that
specifies the partition type globally unique identifier (GUID) for
GPT partitions. You can find the list of partition type GUIDs at
http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs.
- ``--use-uuid``: This option is a Wic-specific option that causes
Wic to generate a random GUID for the partition. The generated
identifier is used in the bootloader configuration to specify the
root partition.
- ``--uuid``: This option is a Wic-specific option that specifies the
partition UUID.
- ``--fsuuid``: This option is a Wic-specific option that specifies
the filesystem UUID. You can generate or modify
:term:`WKS_FILE` with this option if a preconfigured
filesystem UUID is added to the kernel command line in the bootloader
configuration before you run Wic.
- ``--system-id``: This option is a Wic-specific option that
specifies the partition system ID, which is a one byte long,
hexadecimal parameter with or without the 0x prefix.
- ``--mkfs-extraopts``: This option specifies additional options to
pass to the ``mkfs`` utility. Some default options for certain
filesystems do not take effect. See Wic's help on kickstart (i.e.
``wic help kickstart``).
Command: bootloader
===================
This command specifies how the bootloader should be configured and
supports the following options:
.. note::
Bootloader functionality and boot partitions are implemented by the
various
--source
plugins that implement bootloader functionality. The bootloader
command essentially provides a means of modifying bootloader
configuration.
- ``--timeout``: Specifies the number of seconds before the
bootloader times out and boots the default option.
- ``--append``: Specifies kernel parameters. These parameters will be
added to the syslinux ``APPEND`` or ``grub`` kernel command line.
- ``--configfile``: Specifies a user-defined configuration file for
the bootloader. You can provide a full pathname for the file or a
file that exists in the ``canned-wks`` folder. This option overrides
all other bootloader options.
documentation/ref-manual/ref-kickstart.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-kickstart'>
<title>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</title>
documentation/ref-manual/ref-manual-customization.xsl
+2
View File
@@ -1,4 +1,6 @@
<?xml version='1.0'?>
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
<xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/xhtml/docbook.xsl" />
documentation/ref-manual/ref-manual.rst
+31
View File
@@ -0,0 +1,31 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
==============================
Yocto Project Reference Manual
==============================
|
.. toctree::
:caption: Table of Contents
:numbered:
ref-system-requirements
ref-terms
ref-release-process
migration
ref-structure
ref-classes
ref-tasks
ref-devtool-reference
ref-kickstart
ref-qa-checks
ref-images
ref-features
ref-variables
ref-varlocality
faq
resources
history
.. include:: /boilerplate.rst
documentation/ref-manual/ref-manual.xml
+1 -21
View File
@@ -128,28 +128,8 @@
</revision>
<revision>
<revnumber>3.1</revnumber>
<date>April 2020</date>
<revremark>Released with the Yocto Project 3.1 Release.</revremark>
</revision>
<revision>
<revnumber>3.1.1</revnumber>
<date>June 2020</date>
<revremark>Released with the Yocto Project 3.1.1 Release.</revremark>
</revision>
<revision>
<revnumber>3.1.2</revnumber>
<date>August 2020</date>
<revremark>Released with the Yocto Project 3.1.2 Release.</revremark>
</revision>
<revision>
<revnumber>3.1.3</revnumber>
<date>October 2020</date>
<revremark>Released with the Yocto Project 3.1.3 Release.</revremark>
</revision>
<revision>
<revnumber>3.1.4</revnumber>
<date>&REL_MONTH_YEAR;</date>
<revremark>Released with the Yocto Project 3.1.4 Release.</revremark>
<revremark>Released with the Yocto Project 3.1 Release.</revremark>
</revision>
</revhistory>
documentation/ref-manual/ref-qa-checks.rst
+533
View File
@@ -0,0 +1,533 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*****************************
QA Error and Warning Messages
*****************************
.. _qa-introduction:
Introduction
============
When building a recipe, the OpenEmbedded build system performs various
QA checks on the output to ensure that common issues are detected and
reported. Sometimes when you create a new recipe to build new software,
it will build with no problems. When this is not the case, or when you
have QA issues building any software, it could take a little time to
resolve them.
While it is tempting to ignore a QA message or even to disable QA
checks, it is best to try and resolve any reported QA issues. This
chapter provides a list of the QA messages and brief explanations of the
issues you could encounter so that you can properly resolve problems.
The next section provides a list of all QA error and warning messages
based on a default configuration. Each entry provides the message or
error form along with an explanation.
.. note::
- At the end of each message, the name of the associated QA test (as
listed in the ":ref:`insane.bbclass <ref-classes-insane>`"
section) appears within square brackets.
- As mentioned, this list of error and warning messages is for QA
checks only. The list does not cover all possible build errors or
warnings you could encounter.
- Because some QA checks are disabled by default, this list does not
include all possible QA check errors and warnings.
.. _qa-errors-and-warnings:
Errors and Warnings
===================
- ``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]``
The specified package contains files in ``/usr/libexec`` when the
distro configuration uses a different path for ``<libexecdir>`` By
default, ``<libexecdir>`` is ``$prefix/libexec``. However, this
default can be changed (e.g. ``${libdir}``).
 
- ``package <packagename> contains bad RPATH <rpath> in file <file> [rpaths]``
The specified binary produced by the recipe contains dynamic library
load paths (rpaths) that contain build system paths such as
:term:`TMPDIR`, which are incorrect for the target and
could potentially be a security issue. Check for bad ``-rpath``
options being passed to the linker in your
:ref:`ref-tasks-compile` log. Depending on the build
system used by the software being built, there might be a configure
option to disable rpath usage completely within the build of the
software.
 
- ``<packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths]``
The specified binary produced by the recipe contains dynamic library
load paths (rpaths) that on a standard system are searched by default
by the linker (e.g. ``/lib`` and ``/usr/lib``). While these paths
will not cause any breakage, they do waste space and are unnecessary.
Depending on the build system used by the software being built, there
might be a configure option to disable rpath usage completely within
the build of the software.
 
- ``<packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps]``
A file-level dependency has been identified from the specified
package on the specified files, but there is no explicit
corresponding entry in :term:`RDEPENDS`. If
particular files are required at runtime then ``RDEPENDS`` should be
declared in the recipe to ensure the packages providing them are
built.
 
- ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]``
A runtime dependency exists between the two specified packages, but
there is nothing explicit within the recipe to enable the
OpenEmbedded build system to ensure that dependency is satisfied.
This condition is usually triggered by an
:term:`RDEPENDS` value being added at the packaging
stage rather than up front, which is usually automatic based on the
contents of the package. In most cases, you should change the recipe
to add an explicit ``RDEPENDS`` for the dependency.
 
- ``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so]``
Symlink ``.so`` files are for development only, and should therefore
go into the ``-dev`` package. This situation might occur if you add
``*.so*`` rather than ``*.so.*`` to a non-dev package. Change
:term:`FILES` (and possibly
:term:`PACKAGES`) such that the specified ``.so``
file goes into an appropriate ``-dev`` package.
 
- ``non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev]``
Static ``.a`` library files should go into a ``-staticdev`` package.
Change :term:`FILES` (and possibly
:term:`PACKAGES`) such that the specified ``.a`` file
goes into an appropriate ``-staticdev`` package.
 
- ``<packagename>: found library in wrong location [libdir]``
The specified file may have been installed into an incorrect
(possibly hardcoded) installation path. For example, this test will
catch recipes that install ``/lib/bar.so`` when ``${base_libdir}`` is
"lib32". Another example is when recipes install
``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". False
positives occasionally exist. For these cases add "libdir" to
:term:`INSANE_SKIP` for the package.
 
- ``non debug package contains .debug directory: <packagename> path <path> [debug-files]``
The specified package contains a ``.debug`` directory, which should
not appear in anything but the ``-dbg`` package. This situation might
occur if you add a path which contains a ``.debug`` directory and do
not explicitly add the ``.debug`` directory to the ``-dbg`` package.
If this is the case, add the ``.debug`` directory explicitly to
``FILES_${PN}-dbg``. See :term:`FILES` for additional
information on ``FILES``.
 
- ``Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch]``
By default, the OpenEmbedded build system checks the Executable and
Linkable Format (ELF) type, bit size, and endianness of any binaries
to ensure they match the target architecture. This test fails if any
binaries do not match the type since there would be an
incompatibility. The test could indicate that the wrong compiler or
compiler options have been used. Sometimes software, like
bootloaders, might need to bypass this check. If the file you receive
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
:term:`INSANE_SKIP` for the package. Another
option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
 
- ``Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch]``
By default, the OpenEmbedded build system checks the Executable and
Linkable Format (ELF) type, bit size, and endianness of any binaries
to ensure they match the target architecture. This test fails if any
binaries do not match the type since there would be an
incompatibility. The test could indicate that the wrong compiler or
compiler options have been used. Sometimes software, like
bootloaders, might need to bypass this check. If the file you receive
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
:term:`INSANE_SKIP` for the package. Another
option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
 
- ``Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch]``
By default, the OpenEmbedded build system checks the Executable and
Linkable Format (ELF) type, bit size, and endianness of any binaries
to ensure they match the target architecture. This test fails if any
binaries do not match the type since there would be an
incompatibility. The test could indicate that the wrong compiler or
compiler options have been used. Sometimes software, like
bootloaders, might need to bypass this check. If the file you receive
the error for is firmware that is not intended to be executed within
the target operating system or is intended to run on a separate
processor within the device, you can add "arch" to
:term:`INSANE_SKIP` for the package. Another
option is to check the :ref:`ref-tasks-compile` log
and verify that the compiler options being used are correct.
 
- ``ELF binary '<file>' has relocations in .text [textrel]``
The specified ELF binary contains relocations in its ``.text``
sections. This situation can result in a performance impact at
runtime.
Typically, the way to solve this performance issue is to add "-fPIC"
or "-fpic" to the compiler command-line options. For example, given
software that reads :term:`CFLAGS` when you build it,
you could add the following to your recipe:
::
CFLAGS_append = " -fPIC "
For more information on text relocations at runtime, see
http://www.akkadia.org/drepper/textrelocs.html.
 
- ``No GNU_HASH in the elf binary: '<file>' [ldflags]``
This indicates that binaries produced when building the recipe have
not been linked with the :term:`LDFLAGS` options
provided by the build system. Check to be sure that the ``LDFLAGS``
variable is being passed to the linker command. A common workaround
for this situation is to pass in ``LDFLAGS`` using
:term:`TARGET_CC_ARCH` within the recipe as
follows:
::
TARGET_CC_ARCH += "${LDFLAGS}"
 
- ``Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi]``
The specified package contains an Xorg driver, but does not have a
corresponding ABI package dependency. The xserver-xorg recipe
provides driver ABI names. All drivers should depend on the ABI
versions that they have been built against. Driver recipes that
include ``xorg-driver-input.inc`` or ``xorg-driver-video.inc`` will
automatically get these versions. Consequently, you should only need
to explicitly add dependencies to binary driver recipes.
 
- ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]``
The ``/usr/share/info/dir`` should not be packaged. Add the following
line to your :ref:`ref-tasks-install` task or to your
``do_install_append`` within the recipe as follows:
::
rm ${D}${infodir}/dir
 
- ``Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot]``
The specified symlink points into :term:`TMPDIR` on the
host. Such symlinks will work on the host. However, they are clearly
invalid when running on the target. You should either correct the
symlink to use a relative path or remove the symlink.
 
- ``<file> failed sanity test (workdir) in path <path> [la]``
The specified ``.la`` file contains :term:`TMPDIR`
paths. Any ``.la`` file containing these paths is incorrect since
``libtool`` adds the correct sysroot prefix when using the files
automatically itself.
 
- ``<file> failed sanity test (tmpdir) in path <path> [pkgconfig]``
The specified ``.pc`` file contains
:term:`TMPDIR`\ ``/``\ :term:`WORKDIR`
paths. Any ``.pc`` file containing these paths is incorrect since
``pkg-config`` itself adds the correct sysroot prefix when the files
are accessed.
 
- ``<packagename> rdepends on <debug_packagename> [debug-deps]``
A dependency exists between the specified non-dbg package (i.e. a
package whose name does not end in ``-dbg``) and a package that is a
``dbg`` package. The ``dbg`` packages contain debug symbols and are
brought in using several different methods:
- Using the ``dbg-pkgs``
:term:`IMAGE_FEATURES` value.
- Using :term:`IMAGE_INSTALL`.
- As a dependency of another ``dbg`` package that was brought in
using one of the above methods.
The dependency might have been automatically added because the
``dbg`` package erroneously contains files that it should not contain
(e.g. a non-symlink ``.so`` file) or it might have been added
manually (e.g. by adding to :term:`RDEPENDS`).
 
- ``<packagename> rdepends on <dev_packagename> [dev-deps]``
A dependency exists between the specified non-dev package (a package
whose name does not end in ``-dev``) and a package that is a ``dev``
package. The ``dev`` packages contain development headers and are
usually brought in using several different methods:
- Using the ``dev-pkgs``
:term:`IMAGE_FEATURES` value.
- Using :term:`IMAGE_INSTALL`.
- As a dependency of another ``dev`` package that was brought in
using one of the above methods.
The dependency might have been automatically added (because the
``dev`` package erroneously contains files that it should not have
(e.g. a non-symlink ``.so`` file) or it might have been added
manually (e.g. by adding to :term:`RDEPENDS`).
 
- ``<var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]``
If you are adding a versioned dependency relationship to one of the
dependency variables (:term:`RDEPENDS`,
:term:`RRECOMMENDS`,
:term:`RSUGGESTS`,
:term:`RPROVIDES`,
:term:`RREPLACES`, or
:term:`RCONFLICTS`), you must only use the named
comparison operators. Change the versioned dependency values you are
adding to match those listed in the message.
 
- ``<recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path]``
The log for the :ref:`ref-tasks-compile` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
file.
 
- ``<recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path]``
The log for the :ref:`ref-tasks-install` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
file.
 
- ``This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>'``
The log for the :ref:`ref-tasks-configure` task
indicates that paths on the host were searched for files, which is
not appropriate when cross-compiling. Look for "is unsafe for
cross-compilation" or "CROSS COMPILE Badness" in the specified log
file.
 
- ``<packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname]``
The convention within the OpenEmbedded build system (sometimes
enforced by the package manager itself) is to require that package
names are all lower case and to allow a restricted set of characters.
If your recipe name does not match this, or you add packages to
:term:`PACKAGES` that do not conform to the
convention, then you will receive this error. Rename your recipe. Or,
if you have added a non-conforming package name to ``PACKAGES``,
change the package name appropriately.
 
- ``<recipe>: configure was passed unrecognized options: <options> [unknown-configure-option]``
The configure script is reporting that the specified options are
unrecognized. This situation could be because the options were
previously valid but have been removed from the configure script. Or,
there was a mistake when the options were added and there is another
option that should be used instead. If you are unsure, consult the
upstream build documentation, the ``./configure --help`` output, and
the upstream change log or release notes. Once you have worked out
what the appropriate change is, you can update
:term:`EXTRA_OECONF`,
:term:`PACKAGECONFIG_CONFARGS`, or the
individual :term:`PACKAGECONFIG` option values
accordingly.
 
- ``Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]``
The specified recipe has a name (:term:`PN`) value that
appears in :term:`OVERRIDES`. If a recipe is named
such that its ``PN`` value matches something already in ``OVERRIDES``
(e.g. ``PN`` happens to be the same as :term:`MACHINE`
or :term:`DISTRO`), it can have unexpected
consequences. For example, assignments such as
``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``.
Rename your recipe (or if ``PN`` is being set explicitly, change the
``PN`` value) so that the conflict does not occur. See
:term:`FILES` for additional information.
 
- ``<recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck]``
Certain variables (:term:`RDEPENDS`,
:term:`RRECOMMENDS`,
:term:`RSUGGESTS`,
:term:`RCONFLICTS`,
:term:`RPROVIDES`,
:term:`RREPLACES`, :term:`FILES`,
``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and
:term:`ALLOW_EMPTY`) should always be set specific
to a package (i.e. they should be set with a package name override
such as ``RDEPENDS_${PN} = "value"`` rather than
``RDEPENDS = "value"``). If you receive this error, correct any
assignments to these variables within your recipe.
 
- ``File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped]``
Produced binaries have already been stripped prior to the build
system extracting debug symbols. It is common for upstream software
projects to default to stripping debug symbols for output binaries.
In order for debugging to work on the target using ``-dbg`` packages,
this stripping must be disabled.
Depending on the build system used by the software being built,
disabling this stripping could be as easy as specifying an additional
configure option. If not, disabling stripping might involve patching
the build scripts. In the latter case, look for references to "strip"
or "STRIP", or the "-s" or "-S" command-line options being specified
on the linker command line (possibly through the compiler command
line if preceded with "-Wl,").
.. note::
Disabling stripping here does not mean that the final packaged
binaries will be unstripped. Once the OpenEmbedded build system
splits out debug symbols to the
-dbg
package, it will then strip the symbols from the binaries.
 
- ``<packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]``
Package names must appear only once in the
:term:`PACKAGES` variable. You might receive this
error if you are attempting to add a package to ``PACKAGES`` that is
already in the variable's value.
 
- ``FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]``
The string "//" is invalid in a Unix path. Correct all occurrences
where this string appears in a :term:`FILES` variable so
that there is only a single "/".
 
- ``<recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped]``
Files have been installed within the
:ref:`ref-tasks-install` task but have not been
included in any package by way of the :term:`FILES`
variable. Files that do not appear in any package cannot be present
in an image later on in the build process. You need to do one of the
following:
- Add the files to ``FILES`` for the package you want them to appear
in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main
package).
- Delete the files at the end of the ``do_install`` task if the
files are not needed in any package.
 
- ``<oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later``
This message means that both ``<oldpackage>`` and ``<newpackage>``
provide the specified shared library. You can expect this message
when a recipe has been renamed. However, if that is not the case, the
message might indicate that a private version of a library is being
erroneously picked up as the provider for a common library. If that
is the case, you should add the library's ``.so`` file name to
:term:`PRIVATE_LIBS` in the recipe that provides
the private version of the library.
- ``LICENSE_<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]``
The :term:`LICENSE` of the recipe should be a superset
of all the licenses of all packages produced by this recipe. In other
words, any license in ``LICENSE_*`` should also appear in
:term:`LICENSE`.
 
Configuring and Disabling QA Checks
===================================
You can configure the QA checks globally so that specific check failures
either raise a warning or an error message, using the
:term:`WARN_QA` and :term:`ERROR_QA`
variables, respectively. You can also disable checks within a particular
recipe using :term:`INSANE_SKIP`. For information on
how to work with the QA checks, see the
":ref:`insane.bbclass <ref-classes-insane>`" section.
.. note::
Please keep in mind that the QA checks exist in order to detect real
or potential problems in the packaged output. So exercise caution
when disabling these checks.
documentation/ref-manual/ref-qa-checks.xml
+26
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-qa-checks'>
<title>QA Error and Warning Messages</title>
@@ -1170,6 +1171,31 @@ can be found then it should be implemented. I can't find one at the moment.
</listitem>
</itemizedlist>
</para>
<para>
<itemizedlist>
<listitem>
<para id='qa-issue-unlisted-pkg-lics'>
<code>
LICENSE_&lt;packagename&gt; includes licenses (&lt;licenses&gt;) that are not listed in LICENSE [unlisted-pkg-lics]
</code>
</para>
<para>
The <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
of the recipe should be a superset of all the licenses of
all packages produced by this recipe.
In other words, any license in <filename>LICENSE_*</filename>
should also appear in
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>.
</para>
<para>
&nbsp;
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id='configuring-and-disabling-qa-checks'>
documentation/ref-manual/ref-release-process.rst
+193
View File
@@ -0,0 +1,193 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*****************************************************
Yocto Project Releases and the Stable Release Process
*****************************************************
The Yocto Project release process is predictable and consists of both
major and minor (point) releases. This brief chapter provides
information on how releases are named, their life cycle, and their
stability.
Major and Minor Release Cadence
===============================
The Yocto Project delivers major releases (e.g. DISTRO) using a six
month cadence roughly timed each April and October of the year.
Following are examples of some major YP releases with their codenames
also shown. See the "`Major Release
Codenames <#major-release-codenames>`__" section for information on
codenames used with major releases.
- 2.2 (Morty)
- 2.1 (Krogoth)
- 2.0 (Jethro)
While the cadence is never perfect, this timescale facilitates
regular releases that have strong QA cycles while not overwhelming users
with too many new releases. The cadence is predictable and avoids many
major holidays in various geographies.
The Yocto project delivers minor (point) releases on an unscheduled
basis and are usually driven by the accumulation of enough significant
fixes or enhancements to the associated major release. Following are
some example past point releases:
- 2.1.1
- 2.1.2
- 2.2.1
The point release
indicates a point in the major release branch where a full QA cycle and
release process validates the content of the new branch.
.. note::
Realize that there can be patches merged onto the stable release
branches as and when they become available.
Major Release Codenames
=======================
Each major release receives a codename that identifies the release in
the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`.
The concept is that branches of :term:`Metadata` with the same
codename are likely to be compatible and thus work together.
.. note::
Codenames are associated with major releases because a Yocto Project
release number (e.g. DISTRO) could conflict with a given layer or
company versioning scheme. Codenames are unique, interesting, and
easily identifiable.
Releases are given a nominal release version as well but the codename is
used in repositories for this reason. You can find information on Yocto
Project releases and codenames at
https://wiki.yoctoproject.org/wiki/Releases.
Stable Release Process
======================
Once released, the release enters the stable release process at which
time a person is assigned as the maintainer for that stable release.
This maintainer monitors activity for the release by investigating and
handling nominated patches and backport activity. Only fixes and
enhancements that have first been applied on the "master" branch (i.e.
the current, in-development branch) are considered for backporting to a
stable release.
.. note::
The current Yocto Project policy regarding backporting is to consider
bug fixes and security fixes only. Policy dictates that features are
not backported to a stable release. This policy means generic recipe
version upgrades are unlikely to be accepted for backporting. The
exception to this policy occurs when a strong reason exists such as
the fix happens to also be the preferred upstream approach.
Stable release branches have strong maintenance for about a year after
their initial release. Should significant issues be found for any
release regardless of its age, fixes could be backported to older
releases. For issues that are not backported given an older release,
Community LTS trees and branches exist where community members share
patches for older releases. However, these types of patches do not go
through the same release process as do point releases. You can find more
information about stable branch maintenance at
https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance.
Testing and Quality Assurance
=============================
Part of the Yocto Project development and release process is quality
assurance through the execution of test strategies. Test strategies
provide the Yocto Project team a way to ensure a release is validated.
Additionally, because the test strategies are visible to you as a
developer, you can validate your projects. This section overviews the
available test infrastructure used in the Yocto Project. For information
on how to run available tests on your projects, see the
":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual.
The QA/testing infrastructure is woven into the project to the point
where core developers take some of it for granted. The infrastructure
consists of the following pieces:
- ``bitbake-selftest``: A standalone command that runs unit tests on
key pieces of BitBake and its fetchers.
- :ref:`sanity.bbclass <ref-classes-sanity>`: This automatically
included class checks the build environment for missing tools (e.g.
``gcc``) or common misconfigurations such as
:term:`MACHINE` set incorrectly.
- :ref:`insane.bbclass <ref-classes-insane>`: This class checks the
generated output from builds for sanity. For example, if building for
an ARM target, did the build produce ARM binaries. If, for example,
the build produced PPC binaries then there is a problem.
- :ref:`testimage.bbclass <ref-classes-testimage*>`: This class
performs runtime testing of images after they are built. The tests
are usually used with :doc:`QEMU <../dev-manual/dev-manual-qemu>`
to boot the images and check the combined runtime result boot
operation and functions. However, the test can also use the IP
address of a machine to test.
- :ref:`ptest <dev-manual/dev-manual-common-tasks:testing packages with ptest>`:
Runs tests against packages produced during the build for a given
piece of software. The test allows the packages to be be run within a
target image.
- ``oe-selftest``: Tests combination BitBake invocations. These tests
operate outside the OpenEmbedded build system itself. The
``oe-selftest`` can run all tests by default or can run selected
tests or test suites.
.. note::
Running
oe-selftest
requires host packages beyond the "Essential" grouping. See the "
Required Packages for the Build Host
" section for more information.
Originally, much of this testing was done manually. However, significant
effort has been made to automate the tests so that more people can use
them and the Yocto Project development team can run them faster and more
efficiently.
The Yocto Project's main Autobuilder (https://autobuilder.yoctoproject.org/)
publicly tests each Yocto Project release's code in the
:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing
occurs for both the current state of the "master" branch and also for
submitted patches. Testing for submitted patches usually occurs in the
"ross/mut" branch in the ``poky-contrib`` repository (i.e. the
master-under-test branch) or in the "master-next" branch in the ``poky``
repository.
.. note::
You can find all these branches in the Yocto Project
Source Repositories
.
Testing within these public branches ensures in a publicly visible way
that all of the main supposed architectures and recipes in OE-Core
successfully build and behave properly.
Various features such as ``multilib``, sub architectures (e.g. ``x32``,
``poky-tiny``, ``musl``, ``no-x11`` and and so forth),
``bitbake-selftest``, and ``oe-selftest`` are tested as part of the QA
process of a release. Complete testing and validation for a release
takes the Autobuilder workers several hours.
.. note::
The Autobuilder workers are non-homogeneous, which means regular
testing across a variety of Linux distributions occurs. The
Autobuilder is limited to only testing QEMU-based setups and not real
hardware.
Finally, in addition to the Autobuilder's tests, the Yocto Project QA
team also performs testing on a variety of platforms, which includes
actual hardware, to ensure expected results.
documentation/ref-manual/ref-release-process.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-release-process'>
<title>Yocto Project Releases and the Stable Release Process</title>
documentation/ref-manual/ref-structure.rst
+890
View File
@@ -0,0 +1,890 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
**************************
Source Directory Structure
**************************
The :term:`Source Directory` consists of numerous files,
directories and subdirectories; understanding their locations and
contents is key to using the Yocto Project effectively. This chapter
describes the Source Directory and gives information about those files
and directories.
For information on how to establish a local Source Directory on your
development system, see the
":ref:`dev-manual/dev-manual-start:locating yocto project source files`"
section in the Yocto Project Development Tasks Manual.
.. note::
The OpenEmbedded build system does not support file or directory
names that contain spaces. Be sure that the Source Directory you use
does not contain these types of names.
.. _structure-core:
Top-Level Core Components
=========================
This section describes the top-level components of the :term:`Source Directory`.
.. _structure-core-bitbake:
``bitbake/``
------------
This directory includes a copy of BitBake for ease of use. The copy
usually matches the current stable BitBake release from the BitBake
project. BitBake, a :term:`Metadata` interpreter, reads the
Yocto Project Metadata and runs the tasks defined by that data. Failures
are usually caused by errors in your Metadata and not from BitBake
itself; consequently, most users do not need to worry about BitBake.
When you run the ``bitbake`` command, the main BitBake executable (which
resides in the ``bitbake/bin/`` directory) starts. Sourcing the
environment setup script (i.e. :ref:`structure-core-script`) places
the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into
the shell's ``PATH`` environment variable.
For more information on BitBake, see the :doc:`BitBake User Manual
<bitbake:index>`.
.. _structure-core-build:
``build/``
----------
This directory contains user configuration files and the output
generated by the OpenEmbedded build system in its standard configuration
where the source tree is combined with the output. The :term:`Build Directory`
is created initially when you ``source``
the OpenEmbedded build environment setup script (i.e.
:ref:`structure-core-script`).
It is also possible to place output and configuration files in a
directory separate from the :term:`Source Directory` by
providing a directory name when you ``source`` the setup script. For
information on separating output from your local Source Directory files
(commonly described as an "out of tree" build), see the
":ref:`structure-core-script`" section.
.. _handbook:
``documentation/``
------------------
This directory holds the source for the Yocto Project documentation as
well as templates and tools that allow you to generate PDF and HTML
versions of the manuals. Each manual is contained in its own sub-folder;
for example, the files for this reference manual reside in the
``ref-manual/`` directory.
.. _structure-core-meta:
``meta/``
---------
This directory contains the minimal, underlying OpenEmbedded-Core
metadata. The directory holds recipes, common classes, and machine
configuration for strictly emulated targets (``qemux86``, ``qemuarm``,
and so forth.)
.. _structure-core-meta-poky:
``meta-poky/``
--------------
Designed above the ``meta/`` content, this directory adds just enough
metadata to define the Poky reference distribution.
.. _structure-core-meta-yocto-bsp:
``meta-yocto-bsp/``
-------------------
This directory contains the Yocto Project reference hardware Board
Support Packages (BSPs). For more information on BSPs, see the
:doc:`../bsp-guide/bsp-guide`.
.. _structure-meta-selftest:
``meta-selftest/``
------------------
This directory adds additional recipes and append files used by the
OpenEmbedded selftests to verify the behavior of the build system. You
do not have to add this layer to your ``bblayers.conf`` file unless you
want to run the selftests.
.. _structure-meta-skeleton:
``meta-skeleton/``
------------------
This directory contains template recipes for BSP and kernel development.
.. _structure-core-scripts:
``scripts/``
------------
This directory contains various integration scripts that implement extra
functionality in the Yocto Project environment (e.g. QEMU scripts). The
:ref:`structure-core-script` script prepends this directory to the
shell's ``PATH`` environment variable.
The ``scripts`` directory has useful scripts that assist in contributing
back to the Yocto Project, such as ``create-pull-request`` and
``send-pull-request``.
.. _structure-core-script:
``oe-init-build-env``
---------------------
This script sets up the OpenEmbedded build environment. Running this
script with the ``source`` command in a shell makes changes to ``PATH``
and sets other core BitBake variables based on the current working
directory. You need to run an environment setup script before running
BitBake commands. The script uses other scripts within the ``scripts``
directory to do the bulk of the work.
When you run this script, your Yocto Project environment is set up, a
:term:`Build Directory` is created, your working
directory becomes the Build Directory, and you are presented with some
simple suggestions as to what to do next, including a list of some
possible targets to build. Here is an example:
::
$ source oe-init-build-env
### Shell environment set up for builds. ###
You can now run 'bitbake <target>'
Common targets are:
core-image-minimal
core-image-sato
meta-toolchain
meta-ide-support
You can also run generated qemu images with a command like 'runqemu qemux86-64'
The default output of the ``oe-init-build-env`` script is from the
``conf-notes.txt`` file, which is found in the ``meta-poky`` directory
within the :term:`Source Directory`. If you design a
custom distribution, you can include your own version of this
configuration file to mention the targets defined by your distribution.
See the
":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`"
section in the Yocto Project Development Tasks Manual for more
information.
By default, running this script without a Build Directory argument
creates the ``build/`` directory in your current working directory. If
you provide a Build Directory argument when you ``source`` the script,
you direct the OpenEmbedded build system to create a Build Directory of
your choice. For example, the following command creates a Build
Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:
::
$ source OE_INIT_FILE ~/mybuilds
The OpenEmbedded build system uses the template configuration files, which
are found by default in the ``meta-poky/conf/`` directory in the Source
Directory. See the
":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`"
section in the Yocto Project Development Tasks Manual for more
information.
.. note::
The OpenEmbedded build system does not support file or directory
names that contain spaces. If you attempt to run the
OE_INIT_FILE
script from a Source Directory that contains spaces in either the
filenames or directory names, the script returns an error indicating
no such file or directory. Be sure to use a Source Directory free of
names containing spaces.
.. _structure-basic-top-level:
``LICENSE, README, and README.hardware``
----------------------------------------
These files are standard top-level files.
.. _structure-build:
The Build Directory - ``build/``
================================
The OpenEmbedded build system creates the :term:`Build Directory`
when you run the build environment setup
script :ref:`structure-core-script`. If you do not give the Build
Directory a specific name when you run the setup script, the name
defaults to ``build/``.
For subsequent parsing and processing, the name of the Build directory
is available via the :term:`TOPDIR` variable.
.. _structure-build-buildhistory:
``build/buildhistory/``
-----------------------
The OpenEmbedded build system creates this directory when you enable
build history via the ``buildhistory`` class file. The directory
organizes build information into image, packages, and SDK
subdirectories. For information on the build history feature, see the
":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`"
section in the Yocto Project Development Tasks Manual.
.. _structure-build-conf-local.conf:
``build/conf/local.conf``
-------------------------
This configuration file contains all the local user configurations for
your build environment. The ``local.conf`` file contains documentation
on the various configuration options. Any variable set here overrides
any variable set elsewhere within the environment unless that variable
is hard-coded within a file (e.g. by using '=' instead of '?='). Some
variables are hard-coded for various reasons but such variables are
relatively rare.
At a minimum, you would normally edit this file to select the target
``MACHINE``, which package types you wish to use
(:term:`PACKAGE_CLASSES`), and the location from
which you want to access downloaded files (``DL_DIR``).
If ``local.conf`` is not present when you start the build, the
OpenEmbedded build system creates it from ``local.conf.sample`` when you
``source`` the top-level build environment setup script
:ref:`structure-core-script`.
The source ``local.conf.sample`` file used depends on the
``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/``
when you are building from the Yocto Project development environment,
and to ``meta/conf/`` when you are building from the OpenEmbedded-Core
environment. Because the script variable points to the source of the
``local.conf.sample`` file, this implies that you can configure your
build environment from any layer by setting the variable in the
top-level build environment setup script as follows:
::
TEMPLATECONF=your_layer/conf
Once the build process gets the sample
file, it uses ``sed`` to substitute final
``${``\ :term:`OEROOT`\ ``}`` values for all
``##OEROOT##`` values.
.. note::
You can see how the
TEMPLATECONF
variable is used by looking at the
scripts/oe-setup-builddir
script in the
Source Directory
. You can find the Yocto Project version of the
local.conf.sample
file in the
meta-poky/conf
directory.
.. _structure-build-conf-bblayers.conf:
``build/conf/bblayers.conf``
----------------------------
This configuration file defines
:ref:`layers <dev-manual/dev-manual-common-tasks:understanding and creating layers>`,
which are directory trees, traversed (or walked) by BitBake. The
``bblayers.conf`` file uses the :term:`BBLAYERS`
variable to list the layers BitBake tries to find.
If ``bblayers.conf`` is not present when you start the build, the
OpenEmbedded build system creates it from ``bblayers.conf.sample`` when
you ``source`` the top-level build environment setup script (i.e.
:ref:`structure-core-script`).
As with the ``local.conf`` file, the source ``bblayers.conf.sample``
file used depends on the ``$TEMPLATECONF`` script variable, which
defaults to ``meta-poky/conf/`` when you are building from the Yocto
Project development environment, and to ``meta/conf/`` when you are
building from the OpenEmbedded-Core environment. Because the script
variable points to the source of the ``bblayers.conf.sample`` file, this
implies that you can base your build from any layer by setting the
variable in the top-level build environment setup script as follows:
::
TEMPLATECONF=your_layer/conf
Once the build process gets the sample file, it uses ``sed`` to substitute final
``${``\ :term:`OEROOT`\ ``}`` values for all ``##OEROOT##`` values.
.. note::
You can see how the
TEMPLATECONF
variable
scripts/oe-setup-builddir
script in the
Source Directory
. You can find the Yocto Project version of the
bblayers.conf.sample
file in the
meta-poky/conf/
directory.
.. _structure-build-conf-sanity_info:
``build/cache/sanity_info``
---------------------------
This file indicates the state of the sanity checks and is created during
the build.
.. _structure-build-downloads:
``build/downloads/``
--------------------
This directory contains downloaded upstream source tarballs. You can
reuse the directory for multiple builds or move the directory to another
location. You can control the location of this directory through the
``DL_DIR`` variable.
.. _structure-build-sstate-cache:
``build/sstate-cache/``
-----------------------
This directory contains the shared state cache. You can reuse the
directory for multiple builds or move the directory to another location.
You can control the location of this directory through the
``SSTATE_DIR`` variable.
.. _structure-build-tmp:
``build/tmp/``
--------------
The OpenEmbedded build system creates and uses this directory for all
the build system's output. The :term:`TMPDIR` variable
points to this directory.
BitBake creates this directory if it does not exist. As a last resort,
to clean up a build and start it from scratch (other than the
downloads), you can remove everything in the ``tmp`` directory or get
rid of the directory completely. If you do, you should also completely
remove the ``build/sstate-cache`` directory.
.. _structure-build-tmp-buildstats:
``build/tmp/buildstats/``
-------------------------
This directory stores the build statistics.
.. _structure-build-tmp-cache:
``build/tmp/cache/``
--------------------
When BitBake parses the metadata (recipes and configuration files), it
caches the results in ``build/tmp/cache/`` to speed up future builds.
The results are stored on a per-machine basis.
During subsequent builds, BitBake checks each recipe (together with, for
example, any files included or appended to it) to see if they have been
modified. Changes can be detected, for example, through file
modification time (mtime) changes and hashing of file contents. If no
changes to the file are detected, then the parsed result stored in the
cache is reused. If the file has changed, it is reparsed.
.. _structure-build-tmp-deploy:
``build/tmp/deploy/``
---------------------
This directory contains any "end result" output from the OpenEmbedded
build process. The :term:`DEPLOY_DIR` variable points
to this directory. For more detail on the contents of the ``deploy``
directory, see the
":ref:`images-dev-environment`" and
":ref:`sdk-dev-environment`" sections in the Yocto
Project Overview and Concepts Manual.
.. _structure-build-tmp-deploy-deb:
``build/tmp/deploy/deb/``
-------------------------
This directory receives any ``.deb`` packages produced by the build
process. The packages are sorted into feeds for different architecture
types.
.. _structure-build-tmp-deploy-rpm:
``build/tmp/deploy/rpm/``
-------------------------
This directory receives any ``.rpm`` packages produced by the build
process. The packages are sorted into feeds for different architecture
types.
.. _structure-build-tmp-deploy-ipk:
``build/tmp/deploy/ipk/``
-------------------------
This directory receives ``.ipk`` packages produced by the build process.
.. _structure-build-tmp-deploy-licenses:
``build/tmp/deploy/licenses/``
------------------------------
This directory receives package licensing information. For example, the
directory contains sub-directories for ``bash``, ``busybox``, and
``glibc`` (among others) that in turn contain appropriate ``COPYING``
license files with other licensing information. For information on
licensing, see the
":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`"
section in the Yocto Project Development Tasks Manual.
.. _structure-build-tmp-deploy-images:
``build/tmp/deploy/images/``
----------------------------
This directory is populated with the basic output objects of the build
(think of them as the "generated artifacts" of the build process),
including things like the boot loader image, kernel, root filesystem and
more. If you want to flash the resulting image from a build onto a
device, look here for the necessary components.
Be careful when deleting files in this directory. You can safely delete
old images from this directory (e.g. ``core-image-*``). However, the
kernel (``*zImage*``, ``*uImage*``, etc.), bootloader and other
supplementary files might be deployed here prior to building an image.
Because these files are not directly produced from the image, if you
delete them they will not be automatically re-created when you build the
image again.
If you do accidentally delete files here, you will need to force them to
be re-created. In order to do that, you will need to know the target
that produced them. For example, these commands rebuild and re-create
the kernel files:
::
$ bitbake -c clean virtual/kernel
$ bitbake virtual/kernel
.. _structure-build-tmp-deploy-sdk:
``build/tmp/deploy/sdk/``
-------------------------
The OpenEmbedded build system creates this directory to hold toolchain
installer scripts which, when executed, install the sysroot that matches
your target hardware. You can find out more about these installers in
the ":ref:`sdk-manual/sdk-appendix-obtain:building an sdk installer`"
section in the Yocto Project Application Development and the Extensible
Software Development Kit (eSDK) manual.
.. _structure-build-tmp-sstate-control:
``build/tmp/sstate-control/``
-----------------------------
The OpenEmbedded build system uses this directory for the shared state
manifest files. The shared state code uses these files to record the
files installed by each sstate task so that the files can be removed
when cleaning the recipe or when a newer version is about to be
installed. The build system also uses the manifests to detect and
produce a warning when files from one task are overwriting those from
another.
.. _structure-build-tmp-sysroots-components:
``build/tmp/sysroots-components/``
----------------------------------
This directory is the location of the sysroot contents that the task
:ref:`ref-tasks-prepare_recipe_sysroot`
links or copies into the recipe-specific sysroot for each recipe listed
in :term:`DEPENDS`. Population of this directory is
handled through shared state, while the path is specified by the
:term:`COMPONENTS_DIR` variable. Apart from a few
unusual circumstances, handling of the ``sysroots-components`` directory
should be automatic, and recipes should not directly reference
``build/tmp/sysroots-components``.
.. _structure-build-tmp-sysroots:
``build/tmp/sysroots/``
-----------------------
Previous versions of the OpenEmbedded build system used to create a
global shared sysroot per machine along with a native sysroot. Beginning
with the DISTRO version of the Yocto Project, sysroots exist in
recipe-specific :term:`WORKDIR` directories. Thus, the
``build/tmp/sysroots/`` directory is unused.
.. note::
The
build/tmp/sysroots/
directory can still be populated using the
bitbake build-sysroots
command and can be used for compatibility in some cases. However, in
general it is not recommended to populate this directory. Individual
recipe-specific sysroots should be used.
.. _structure-build-tmp-stamps:
``build/tmp/stamps/``
---------------------
This directory holds information that BitBake uses for accounting
purposes to track what tasks have run and when they have run. The
directory is sub-divided by architecture, package name, and version.
Following is an example:
stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do Although
the files in the directory are empty of data, BitBake uses the filenames
and timestamps for tracking purposes.
For information on how BitBake uses stamp files to determine if a task
should be rerun, see the
":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`"
section in the Yocto Project Overview and Concepts Manual.
.. _structure-build-tmp-log:
``build/tmp/log/``
------------------
This directory contains general logs that are not otherwise placed using
the package's ``WORKDIR``. Examples of logs are the output from the
``do_check_pkg`` or ``do_distro_check`` tasks. Running a build does not
necessarily mean this directory is created.
.. _structure-build-tmp-work:
``build/tmp/work/``
-------------------
This directory contains architecture-specific work sub-directories for
packages built by BitBake. All tasks execute from the appropriate work
directory. For example, the source for a particular package is unpacked,
patched, configured and compiled all within its own work directory.
Within the work directory, organization is based on the package group
and version for which the source is being compiled as defined by the
:term:`WORKDIR`.
It is worth considering the structure of a typical work directory. As an
example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86``
built within the Yocto Project. For this package, a work directory of
``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
to as the ``WORKDIR``, is created. Within this directory, the source is
unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
(See the ":ref:`using-a-quilt-workflow`" section in
the Yocto Project Development Tasks Manual for more information.) Within
the ``linux-qemux86-standard-build`` directory, standard Quilt
directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and
standard Quilt commands can be used.
There are other directories generated within ``WORKDIR``. The most
important directory is ``WORKDIR/temp/``, which has log files for each
task (``log.do_*.pid``) and contains the scripts BitBake runs for each
task (``run.do_*.pid``). The ``WORKDIR/image/`` directory is where "make
install" places its output that is then split into sub-packages within
``WORKDIR/packages-split/``.
.. _structure-build-tmp-work-tunearch-recipename-version:
``build/tmp/work/tunearch/recipename/version/``
-----------------------------------------------
The recipe work directory - ``${WORKDIR}``.
As described earlier in the
"```build/tmp/sysroots/`` <#structure-build-tmp-sysroots>`__" section,
beginning with the DISTRO release of the Yocto Project, the OpenEmbedded
build system builds each recipe in its own work directory (i.e.
:term:`WORKDIR`). The path to the work directory is
constructed using the architecture of the given build (e.g.
:term:`TUNE_PKGARCH`,
:term:`MACHINE_ARCH`, or "allarch"), the recipe
name, and the version of the recipe (i.e.
:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`).
A number of key subdirectories exist within each recipe work directory:
- ``${WORKDIR}/temp``: Contains the log files of each task executed for
this recipe, the "run" files for each executed task, which contain
the code run, and a ``log.task_order`` file, which lists the order in
which tasks were executed.
- ``${WORKDIR}/image``: Contains the output of the
:ref:`ref-tasks-install` task, which corresponds to
the ``${``\ :term:`D`\ ``}`` variable in that task.
- ``${WORKDIR}/pseudo``: Contains the pseudo database and log for any
tasks executed under pseudo for the recipe.
- ``${WORKDIR}/sysroot-destdir``: Contains the output of the
:ref:`ref-tasks-populate_sysroot` task.
- ``${WORKDIR}/package``: Contains the output of the
:ref:`ref-tasks-package` task before the output is
split into individual packages.
- ``${WORKDIR}/packages-split``: Contains the output of the
``do_package`` task after the output has been split into individual
packages. Subdirectories exist for each individual package created by
the recipe.
- ``${WORKDIR}/recipe-sysroot``: A directory populated with the target
dependencies of the recipe. This directory looks like the target
filesystem and contains libraries that the recipe might need to link
against (e.g. the C library).
- ``${WORKDIR}/recipe-sysroot-native``: A directory populated with the
native dependencies of the recipe. This directory contains the tools
the recipe needs to build (e.g. the compiler, Autoconf, libtool, and
so forth).
- ``${WORKDIR}/build``: This subdirectory applies only to recipes that
support builds where the source is separate from the build artifacts.
The OpenEmbedded build system uses this directory as a separate build
directory (i.e. ``${``\ :term:`B`\ ``}``).
.. _structure-build-work-shared:
``build/tmp/work-shared/``
--------------------------
For efficiency, the OpenEmbedded build system creates and uses this
directory to hold recipes that share a work directory with other
recipes. In practice, this is only used for ``gcc`` and its variants
(e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth).
.. _structure-meta:
The Metadata - ``meta/``
========================
As mentioned previously, :term:`Metadata` is the core of the
Yocto Project. Metadata has several important subdivisions:
.. _structure-meta-classes:
``meta/classes/``
-----------------
This directory contains the ``*.bbclass`` files. Class files are used to
abstract common code so it can be reused by multiple packages. Every
package inherits the ``base.bbclass`` file. Examples of other important
classes are ``autotools.bbclass``, which in theory allows any
Autotool-enabled package to work with the Yocto Project with minimal
effort. Another example is ``kernel.bbclass`` that contains common code
and functions for working with the Linux kernel. Functions like image
generation or packaging also have their specific class files such as
``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``.
For reference information on classes, see the
":ref:`ref-manual/ref-classes:Classes`" chapter.
.. _structure-meta-conf:
``meta/conf/``
--------------
This directory contains the core set of configuration files that start
from ``bitbake.conf`` and from which all other configuration files are
included. See the include statements at the end of the ``bitbake.conf``
file and you will note that even ``local.conf`` is loaded from there.
While ``bitbake.conf`` sets up the defaults, you can often override
these by using the (``local.conf``) file, machine file or the
distribution configuration file.
.. _structure-meta-conf-machine:
``meta/conf/machine/``
----------------------
This directory contains all the machine configuration files. If you set
``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a
``qemux86.conf`` file in this directory. The ``include`` directory
contains various data common to multiple machines. If you want to add
support for a new machine to the Yocto Project, look in this directory.
.. _structure-meta-conf-distro:
``meta/conf/distro/``
---------------------
The contents of this directory controls any distribution-specific
configurations. For the Yocto Project, the ``defaultsetup.conf`` is the
main file here. This directory includes the versions and the ``SRCDATE``
definitions for applications that are configured here. An example of an
alternative configuration might be ``poky-bleeding.conf``. Although this
file mainly inherits its configuration from Poky.
.. _structure-meta-conf-machine-sdk:
``meta/conf/machine-sdk/``
--------------------------
The OpenEmbedded build system searches this directory for configuration
files that correspond to the value of
:term:`SDKMACHINE`. By default, 32-bit and 64-bit x86
files ship with the Yocto Project that support some SDK hosts. However,
it is possible to extend that support to other SDK hosts by adding
additional configuration files in this subdirectory within another
layer.
.. _structure-meta-files:
``meta/files/``
---------------
This directory contains common license files and several text files used
by the build system. The text files contain minimal device information
and lists of files and directories with known permissions.
.. _structure-meta-lib:
``meta/lib/``
-------------
This directory contains OpenEmbedded Python library code used during the
build process.
.. _structure-meta-recipes-bsp:
``meta/recipes-bsp/``
---------------------
This directory contains anything linking to specific hardware or
hardware configuration information such as "u-boot" and "grub".
.. _structure-meta-recipes-connectivity:
``meta/recipes-connectivity/``
------------------------------
This directory contains libraries and applications related to
communication with other devices.
.. _structure-meta-recipes-core:
``meta/recipes-core/``
----------------------
This directory contains what is needed to build a basic working Linux
image including commonly used dependencies.
.. _structure-meta-recipes-devtools:
``meta/recipes-devtools/``
--------------------------
This directory contains tools that are primarily used by the build
system. The tools, however, can also be used on targets.
.. _structure-meta-recipes-extended:
``meta/recipes-extended/``
--------------------------
This directory contains non-essential applications that add features
compared to the alternatives in core. You might need this directory for
full tool functionality or for Linux Standard Base (LSB) compliance.
.. _structure-meta-recipes-gnome:
``meta/recipes-gnome/``
-----------------------
This directory contains all things related to the GTK+ application
framework.
.. _structure-meta-recipes-graphics:
``meta/recipes-graphics/``
--------------------------
This directory contains X and other graphically related system
libraries.
.. _structure-meta-recipes-kernel:
``meta/recipes-kernel/``
------------------------
This directory contains the kernel and generic applications and
libraries that have strong kernel dependencies.
.. _structure-meta-recipes-lsb4:
``meta/recipes-lsb4/``
----------------------
This directory contains recipes specifically added to support the Linux
Standard Base (LSB) version 4.x.
.. _structure-meta-recipes-multimedia:
``meta/recipes-multimedia/``
----------------------------
This directory contains codecs and support utilities for audio, images
and video.
.. _structure-meta-recipes-rt:
``meta/recipes-rt/``
--------------------
This directory contains package and image recipes for using and testing
the ``PREEMPT_RT`` kernel.
.. _structure-meta-recipes-sato:
``meta/recipes-sato/``
----------------------
This directory contains the Sato demo/reference UI/UX and its associated
applications and configuration data.
.. _structure-meta-recipes-support:
``meta/recipes-support/``
-------------------------
This directory contains recipes used by other recipes, but that are not
directly included in images (i.e. dependencies of other recipes).
.. _structure-meta-site:
``meta/site/``
--------------
This directory contains a list of cached results for various
architectures. Because certain "autoconf" test results cannot be
determined when cross-compiling due to the tests not able to run on a
live system, the information in this directory is passed to "autoconf"
for the various architectures.
.. _structure-meta-recipes-txt:
``meta/recipes.txt``
--------------------
This file is a description of the contents of ``recipes-*``.
documentation/ref-manual/ref-structure.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-structure'>
documentation/ref-manual/ref-style.css
+3
View File
@@ -1,4 +1,7 @@
/*
SPDX-License-Identifier: CC-BY-2.0-UK
Generic XHTML / DocBook XHTML CSS Stylesheet.
Browser wrangling and typographic design by
documentation/ref-manual/ref-system-requirements.rst
+437
View File
@@ -0,0 +1,437 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*******************
System Requirements
*******************
Welcome to the Yocto Project Reference Manual! This manual provides
reference information for the current release of the Yocto Project, and
is most effectively used after you have an understanding of the basics
of the Yocto Project. The manual is neither meant to be read as a
starting point to the Yocto Project, nor read from start to finish.
Rather, use this manual to find variable definitions, class
descriptions, and so forth as needed during the course of using the
Yocto Project.
For introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>` and the
":ref:`overview-manual/overview-manual-development-environment:the yocto project development environment`"
chapter in the Yocto Project Overview and Concepts Manual.
If you want to use the Yocto Project to quickly build an image without
having to understand concepts, work through the
:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to"
information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview
and conceptual information in the :doc:`../overview-manual/overview-manual`.
.. note::
For more information about the Yocto Project Documentation set, see
the "
Links and Related Documentation
" section.
.. _detailed-supported-distros:
Supported Linux Distributions
=============================
Currently, the Yocto Project is supported on the following
distributions:
- Ubuntu 16.04 (LTS)
- Ubuntu 18.04 (LTS)
- Ubuntu 20.04
- Fedora 30
- Fedora 31
- Fedora 32
- CentOS 7.x
- CentOS 8.x
- Debian GNU/Linux 8.x (Jessie)
- Debian GNU/Linux 9.x (Stretch)
- Debian GNU/Linux 10.x (Buster)
- OpenSUSE Leap 15.1
.. note::
- While the Yocto Project Team attempts to ensure all Yocto Project
releases are one hundred percent compatible with each officially
supported Linux distribution, instances might exist where you
encounter a problem while using the Yocto Project on a specific
distribution.
- Yocto Project releases are tested against the stable Linux
distributions in the above list. The Yocto Project should work
on other distributions but validation is not performed against
them.
- In particular, the Yocto Project does not support and currently
has no plans to support rolling-releases or development
distributions due to their constantly changing nature. We welcome
patches and bug reports, but keep in mind that our priority is on
the supported platforms listed below.
- You may use Windows Subsystem For Linux v2 to set up a build host
using Windows 10, but validation is not performed against build
hosts using WSLv2.
- The Yocto Project is not compatible with WSLv1, it is
compatible but not officially supported nor validated with
WSLv2, if you still decide to use WSL please upgrade to WSLv2.
- If you encounter problems, please go to `Yocto Project
Bugzilla <http://bugzilla.yoctoproject.org>`__ and submit a bug. We are
interested in hearing about your experience. For information on
how to submit a bug, see the Yocto Project
:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`"
section in the Yocto Project Development Tasks Manual.
Required Packages for the Build Host
====================================
The list of packages you need on the host development system can be
large when covering all build scenarios using the Yocto Project. This
section describes required packages according to Linux distribution and
function.
.. _ubuntu-packages:
Ubuntu and Debian
-----------------
The following list shows the required packages by function given a
supported Ubuntu or Debian Linux distribution:
.. note::
- If your build system has the ``oss4-dev`` package installed, you
might experience QEMU build failures due to the package installing
its own custom ``/usr/include/linux/soundcard.h`` on the Debian
system. If you run into this situation, either of the following
solutions exist:
::
$ sudo apt-get build-dep qemu
$ sudo apt-get remove oss4-dev
- For Debian-8, ``python3-git`` and ``pylint3`` are no longer
available via ``apt-get``.
::
$ sudo pip3 install GitPython pylint==1.9.5
- *Essentials:* Packages needed to build an image on a headless system:
::
$ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
- *Documentation:* Packages needed if you are going to build out the
Yocto Project documentation manuals:
::
$ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto
Fedora Packages
---------------
The following list shows the required packages by function given a
supported Fedora Linux distribution:
- *Essentials:* Packages needed to build an image for a headless
system:
::
$ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
- *Documentation:* Packages needed if you are going to build out the
Yocto Project documentation manuals:
::
$ sudo dnf install docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto
openSUSE Packages
-----------------
The following list shows the required packages by function given a
supported openSUSE Linux distribution:
- *Essentials:* Packages needed to build an image for a headless
system:
::
$ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
- *Documentation:* Packages needed if you are going to build out the
Yocto Project documentation manuals: $ sudo zypper install dblatex
xmlto
CentOS-7 Packages
-----------------
The following list shows the required packages by function given a
supported CentOS-7 Linux distribution:
- *Essentials:* Packages needed to build an image for a headless
system:
::
$ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL;
.. note::
- Extra Packages for Enterprise Linux (i.e. ``epel-release``) is
a collection of packages from Fedora built on RHEL/CentOS for
easy installation of packages not included in enterprise Linux
by default. You need to install these packages separately.
- The ``makecache`` command consumes additional Metadata from
``epel-release``.
- *Documentation:* Packages needed if you are going to build out the
Yocto Project documentation manuals:
::
$ sudo yum install docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto
CentOS-8 Packages
-----------------
The following list shows the required packages by function given a
supported CentOS-8 Linux distribution:
- *Essentials:* Packages needed to build an image for a headless
system:
::
$ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL;
.. note::
- Extra Packages for Enterprise Linux (i.e. ``epel-release``) is
a collection of packages from Fedora built on RHEL/CentOS for
easy installation of packages not included in enterprise Linux
by default. You need to install these packages separately.
- The ``PowerTools`` repo provides additional packages such as
``rpcgen`` and ``texinfo``.
- The ``makecache`` command consumes additional Metadata from
``epel-release``.
- *Documentation:* Packages needed if you are going to build out the
Yocto Project documentation manuals:
::
$ sudo dnf install docbook-style-dsssl docbook-style-xsl \\
docbook-dtds docbook-utils fop libxslt dblatex xmlto
Required Git, tar, Python and gcc Versions
==========================================
In order to use the build system, your host development system must meet
the following version requirements for Git, tar, and Python:
- Git 1.8.3.1 or greater
- tar 1.28 or greater
- Python 3.5.0 or greater
If your host development system does not meet all these requirements,
you can resolve this by installing a ``buildtools`` tarball that
contains these tools. You can get the tarball one of two ways: download
a pre-built tarball or use BitBake to build the tarball.
In addition, your host development system must meet the following
version requirement for gcc:
- gcc 5.0 or greater
If your host development system does not meet this requirement, you can
resolve this by installing a ``buildtools-extended`` tarball that
contains additional tools, the equivalent of ``buildtools-essential``.
Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script
--------------------------------------------------------------------------------
The ``install-buildtools`` script is the easiest of the three methods by
which you can get these tools. It downloads a pre-built buildtools
installer and automatically installs the tools for you:
1. Execute the ``install-buildtools`` script. Here is an example:
::
$ cd poky
$ scripts/install-buildtools --without-extended-buildtools \
--base-url https://downloads.yoctoproject.org/releases/yocto \
--release yocto-&DISTRO; \
--installer-version &DISTRO;
During execution, the buildtools tarball will be downloaded, the
checksum of the download will be verified, the installer will be run
for you, and some basic checks will be run to to make sure the
installation is functional.
To avoid the need of ``sudo`` privileges, the ``install-buildtools``
script will by default tell the installer to install in:
::
/path/to/poky/buildtools
If your host development system needs the additional tools provided
in the ``buildtools-extended`` tarball, you can instead execute the
``install-buildtools`` script with the default parameters:
::
$ cd poky
$ scripts/install-buildtools
2. Source the tools environment setup script by using a command like the
following:
::
$ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
Of course, you need to supply your installation directory and be sure to
use the right file (i.e. i586 or x86_64).
After you have sourced the setup script, the tools are added to
``PATH`` and any other environment variables required to run the
tools are initialized. The results are working versions versions of
Git, tar, Python and ``chrpath``. And in the case of the
``buildtools-extended`` tarball, additional working versions of tools
including ``gcc``, ``make`` and the other tools included in
``packagegroup-core-buildessential``.
Downloading a Pre-Built ``buildtools`` Tarball
----------------------------------------------
Downloading and running a pre-built buildtools installer is the easiest
of the two methods by which you can get these tools:
1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/
2. Execute the installation script. Here is an example for the
traditional installer:
::
$ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh
Here is an example for the extended installer:
::
$ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh
During execution, a prompt appears that allows you to choose the
installation directory. For example, you could choose the following:
/home/your-username/buildtools
3. Source the tools environment setup script by using a command like the
following:
::
$ source /home/your_username/buildtools/environment-setup-i586-poky-linux
Of
course, you need to supply your installation directory and be sure to
use the right file (i.e. i585 or x86-64).
After you have sourced the setup script, the tools are added to
``PATH`` and any other environment variables required to run the
tools are initialized. The results are working versions versions of
Git, tar, Python and ``chrpath``. And in the case of the
``buildtools-extended`` tarball, additional working versions of tools
including ``gcc``, ``make`` and the other tools included in
``packagegroup-core-buildessential``.
Building Your Own ``buildtools`` Tarball
----------------------------------------
Building and running your own buildtools installer applies only when you
have a build host that can already run BitBake. In this case, you use
that machine to build the ``.sh`` file and then take steps to transfer
and run it on a machine that does not meet the minimal Git, tar, and
Python (or gcc) requirements.
Here are the steps to take to build and run your own buildtools
installer:
1. On the machine that is able to run BitBake, be sure you have set up
your build environment with the setup script
(:ref:`structure-core-script`).
2. Run the BitBake command to build the tarball:
::
$ bitbake buildtools-tarball
or run the BitBake command to build the extended tarball:
::
$ bitbake buildtools-extended-tarball
.. note::
The
SDKMACHINE
variable in your
local.conf
file determines whether you build tools for a 32-bit or 64-bit
system.
Once the build completes, you can find the ``.sh`` file that installs
the tools in the ``tmp/deploy/sdk`` subdirectory of the
:term:`Build Directory`. The installer file has the string
"buildtools" (or "buildtools-extended") in the name.
3. Transfer the ``.sh`` file from the build host to the machine that
does not meet the Git, tar, or Python (or gcc) requirements.
4. On the machine that does not meet the requirements, run the ``.sh``
file to install the tools. Here is an example for the traditional
installer:
::
$ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
Here is an example for the extended installer:
::
$ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
During execution, a prompt appears that allows you to choose the
installation directory. For example, you could choose the following:
/home/your_username/buildtools
5. Source the tools environment setup script by using a command like the
following:
::
$ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
Of course, you need to supply your installation directory and be sure to
use the right file (i.e. i586 or x86_64).
After you have sourced the setup script, the tools are added to
``PATH`` and any other environment variables required to run the
tools are initialized. The results are working versions versions of
Git, tar, Python and ``chrpath``. And in the case of the
``buildtools-extended`` tarball, additional working versions of tools
including ``gcc``, ``make`` and the other tools included in
``packagegroup-core-buildessential``.
documentation/ref-manual/ref-system-requirements.xml
+2 -3
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-manual-system-requirements'>
<title>System Requirements</title>
@@ -93,14 +94,12 @@
<itemizedlist>
<listitem><para>Ubuntu 16.04 (LTS)</para></listitem>
<listitem><para>Ubuntu 18.04 (LTS)</para></listitem>
<listitem><para>Ubuntu 19.04</para></listitem>
<listitem><para>Ubuntu 20.04</para></listitem>
<listitem><para>Fedora 28</para></listitem>
<listitem><para>Fedora 29</para></listitem>
<listitem><para>Fedora 30</para></listitem>
<listitem><para>Fedora 31</para></listitem>
<listitem><para>Fedora 32</para></listitem>
<listitem><para>CentOS 7.x</para></listitem>
<listitem><para>CentOS 8.x</para></listitem>
<listitem><para>Debian GNU/Linux 8.x (Jessie)</para></listitem>
<listitem><para>Debian GNU/Linux 9.x (Stretch)</para></listitem>
<listitem><para>Debian GNU/Linux 10.x (Buster)</para></listitem>
documentation/ref-manual/ref-tasks.rst
+875
View File
@@ -0,0 +1,875 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*****
Tasks
*****
Tasks are units of execution for BitBake. Recipes (``.bb`` files) use
tasks to complete configuring, compiling, and packaging software. This
chapter provides a reference of the tasks defined in the OpenEmbedded
build system.
Normal Recipe Build Tasks
=========================
The following sections describe normal tasks associated with building a
recipe. For more information on tasks and dependencies, see the
":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
BitBake User Manual.
.. _ref-tasks-build:
``do_build``
------------
The default task for all recipes. This task depends on all other normal
tasks required to build a recipe.
.. _ref-tasks-compile:
``do_compile``
--------------
Compiles the source code. This task runs with the current working
directory set to ``${``\ :term:`B`\ ``}``.
The default behavior of this task is to run the ``oe_runmake`` function
if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found.
If no such file is found, the ``do_compile`` task does nothing.
.. _ref-tasks-compile_ptest_base:
``do_compile_ptest_base``
-------------------------
Compiles the runtime test suite included in the software being built.
.. _ref-tasks-configure:
``do_configure``
----------------
Configures the source by enabling and disabling any build-time and
configuration options for the software being built. The task runs with
the current working directory set to ``${``\ :term:`B`\ ``}``.
The default behavior of this task is to run ``oe_runmake clean`` if a
makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
:term:`CLEANBROKEN` is not set to "1". If no such
file is found or the ``CLEANBROKEN`` variable is set to "1", the
``do_configure`` task does nothing.
.. _ref-tasks-configure_ptest_base:
``do_configure_ptest_base``
---------------------------
Configures the runtime test suite included in the software being built.
.. _ref-tasks-deploy:
``do_deploy``
-------------
Writes output files that are to be deployed to
``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The
task runs with the current working directory set to
``${``\ :term:`B`\ ``}``.
Recipes implementing this task should inherit the
:ref:`deploy <ref-classes-deploy>` class and should write the output
to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be
confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up
``do_deploy`` as a shared state (sstate) task that can be accelerated
through sstate use. The sstate mechanism takes care of copying the
output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
.. note::
Do not write the output directly to
${DEPLOY_DIR_IMAGE}
, as this causes the sstate mechanism to malfunction.
The ``do_deploy`` task is not added as a task by default and
consequently needs to be added manually. If you want the task to run
after :ref:`ref-tasks-compile`, you can add it by doing
the following: addtask deploy after do_compile Adding ``do_deploy``
after other tasks works the same way.
.. note::
You do not need to add
before do_build
to the
addtask
command (though it is harmless), because the
base
class contains the following:
::
do_build[recrdeptask] += "do_deploy"
See the "
Dependencies
" section in the BitBake User Manual for more information.
If the ``do_deploy`` task re-executes, any previous output is removed
(i.e. "cleaned").
.. _ref-tasks-fetch:
``do_fetch``
------------
Fetches the source code. This task uses the
:term:`SRC_URI` variable and the argument's prefix to
determine the correct :ref:`fetcher <bitbake:bb-fetchers>`
module.
.. _ref-tasks-image:
``do_image``
------------
Starts the image generation process. The ``do_image`` task runs after
the OpenEmbedded build system has run the
:ref:`ref-tasks-rootfs` task during which packages are
identified for installation into the image and the root filesystem is
created, complete with post-processing.
The ``do_image`` task performs pre-processing on the image through the
:term:`IMAGE_PREPROCESS_COMMAND` and
dynamically generates supporting ``do_image_*`` tasks as needed.
For more information on image creation, see the ":ref:`image-generation-dev-environment`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-image-complete:
``do_image_complete``
---------------------
Completes the image generation process. The ``do_image_complete`` task
runs after the OpenEmbedded build system has run the
:ref:`ref-tasks-image` task during which image
pre-processing occurs and through dynamically generated ``do_image_*``
tasks the image is constructed.
The ``do_image_complete`` task performs post-processing on the image
through the
:term:`IMAGE_POSTPROCESS_COMMAND`.
For more information on image creation, see the
":ref:`image-generation-dev-environment`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-install:
``do_install``
--------------
Copies files that are to be packaged into the holding area
``${``\ :term:`D`\ ``}``. This task runs with the current
working directory set to ``${``\ :term:`B`\ ``}``, which is the
compilation directory. The ``do_install`` task, as well as other tasks
that either directly or indirectly depend on the installed files (e.g.
:ref:`ref-tasks-package`, ``do_package_write_*``, and
:ref:`ref-tasks-rootfs`), run under
:ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`.
.. note::
When installing files, be careful not to set the owner and group IDs
of the installed files to unintended values. Some methods of copying
files, notably when using the recursive ``cp`` command, can preserve
the UID and/or GID of the original file, which is usually not what
you want. The ``host-user-contaminated`` QA check checks for files
that probably have the wrong ownership.
Safe methods for installing files include the following:
- The ``install`` utility. This utility is the preferred method.
- The ``cp`` command with the "--no-preserve=ownership" option.
- The ``tar`` command with the "--no-same-owner" option. See the
``bin_package.bbclass`` file in the ``meta/classes`` directory of
the :term:`Source Directory` for an example.
.. _ref-tasks-install_ptest_base:
``do_install_ptest_base``
-------------------------
Copies the runtime test suite files from the compilation directory to a
holding area.
.. _ref-tasks-package:
``do_package``
--------------
Analyzes the content of the holding area
``${``\ :term:`D`\ ``}`` and splits the content into subsets
based on available packages and files. This task makes use of the
:term:`PACKAGES` and :term:`FILES`
variables.
The ``do_package`` task, in conjunction with the
:ref:`ref-tasks-packagedata` task, also saves some
important package metadata. For additional information, see the
:term:`PKGDESTWORK` variable and the
":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
section in the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_qa:
``do_package_qa``
-----------------
Runs QA checks on packaged files. For more information on these checks,
see the :ref:`insane <ref-classes-insane>` class.
.. _ref-tasks-package_write_deb:
``do_package_write_deb``
------------------------
Creates Debian packages (i.e. ``*.deb`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`package-feeds-dev-environment`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_ipk:
``do_package_write_ipk``
------------------------
Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`package-feeds-dev-environment`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_rpm:
``do_package_write_rpm``
------------------------
Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`package-feeds-dev-environment`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-package_write_tar:
``do_package_write_tar``
------------------------
Creates tarballs and places them in the
``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
the package feeds area. For more information, see the
":ref:`package-feeds-dev-environment`" section in
the Yocto Project Overview and Concepts Manual.
.. _ref-tasks-packagedata:
``do_packagedata``
------------------
Saves package metadata generated by the
:ref:`ref-tasks-package` task in
:term:`PKGDATA_DIR` to make it available globally.
.. _ref-tasks-patch:
``do_patch``
------------
Locates patch files and applies them to the source code.
After fetching and unpacking source files, the build system uses the
recipe's :term:`SRC_URI` statements
to locate and apply patch files to the source code.
.. note::
The build system uses the
FILESPATH
variable to determine the default set of directories when searching
for patches.
Patch files, by default, are ``*.patch`` and ``*.diff`` files created
and kept in a subdirectory of the directory holding the recipe file. For
example, consider the
:yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>`
recipe from the OE-Core layer (i.e. ``poky/meta``):
::
poky/meta/recipes-connectivity/bluez5
This recipe has two patch files located here:
::
poky/meta/recipes-connectivity/bluez5/bluez5
In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source
and patch files needed to build the package.
.. note::
In the case for the
bluez5_5.48.bb
recipe, the
SRC_URI
statements are from an include file
bluez5.inc
.
As mentioned earlier, the build system treats files whose file types are
``.patch`` and ``.diff`` as patch files. However, you can use the
"apply=yes" parameter with the ``SRC_URI`` statement to indicate any
file as a patch file:
::
SRC_URI = " \\
git://path_to_repo/some_package \\
file://file;apply=yes \\
"
Conversely, if you have a directory full of patch files and you want to
exclude some so that the ``do_patch`` task does not apply them during
the patch phase, you can use the "apply=no" parameter with the
``SRC_URI`` statement:
::
SRC_URI = " \
git://path_to_repo/some_package \
file://path_to_lots_of_patch_files \
file://path_to_lots_of_patch_files/patch_file5;apply=no \
"
In the
previous example, assuming all the files in the directory holding the
patch files end with either ``.patch`` or ``.diff``, every file would be
applied as a patch by default except for the patch_file5 patch.
You can find out more about the patching process in the
":ref:`patching-dev-environment`" section in
the Yocto Project Overview and Concepts Manual and the
":ref:`new-recipe-patching-code`" section in the
Yocto Project Development Tasks Manual.
.. _ref-tasks-populate_lic:
``do_populate_lic``
-------------------
Writes license information for the recipe that is collected later when
the image is constructed.
.. _ref-tasks-populate_sdk:
``do_populate_sdk``
-------------------
Creates the file and directory structure for an installable SDK. See the
":ref:`sdk-generation-dev-environment`"
section in the Yocto Project Overview and Concepts Manual for more
information.
.. _ref-tasks-populate_sdk_ext:
``do_populate_sdk_ext``
-----------------------
Creates the file and directory structure for an installable extensible
SDK (eSDK). See the ":ref:`sdk-generation-dev-environment`"
section in the Yocto Project Overview and Concepts Manual for more
information.
.. _ref-tasks-populate_sysroot:
``do_populate_sysroot``
-----------------------
Stages (copies) a subset of the files installed by the
:ref:`ref-tasks-install` task into the appropriate
sysroot. For information on how to access these files from other
recipes, see the :term:`STAGING_DIR* <STAGING_DIR_HOST>` variables.
Directories that would typically not be needed by other recipes at build
time (e.g. ``/etc``) are not copied by default.
For information on what directories are copied by default, see the
:term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables. You can change
these variables inside your recipe if you need to make additional (or
fewer) directories available to other recipes at build time.
The ``do_populate_sysroot`` task is a shared state (sstate) task, which
means that the task can be accelerated through sstate use. Realize also
that if the task is re-executed, any previous output is removed (i.e.
"cleaned").
.. _ref-tasks-prepare_recipe_sysroot:
``do_prepare_recipe_sysroot``
-----------------------------
Installs the files into the individual recipe specific sysroots (i.e.
``recipe-sysroot`` and ``recipe-sysroot-native`` under
``${``\ :term:`WORKDIR`\ ``}`` based upon the
dependencies specified by :term:`DEPENDS`). See the
":ref:`staging <ref-classes-staging>`" class for more information.
.. _ref-tasks-rm_work:
``do_rm_work``
--------------
Removes work files after the OpenEmbedded build system has finished with
them. You can learn more by looking at the
":ref:`rm_work.bbclass <ref-classes-rm-work>`" section.
.. _ref-tasks-unpack:
``do_unpack``
-------------
Unpacks the source code into a working directory pointed to by
``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
variable also plays a role in where unpacked source files ultimately
reside. For more information on how source files are unpacked, see the
":ref:`source-fetching-dev-environment`"
section in the Yocto Project Overview and Concepts Manual and also see
the ``WORKDIR`` and ``S`` variable descriptions.
Manually Called Tasks
=====================
These tasks are typically manually triggered (e.g. by using the
``bitbake -c`` command-line option):
.. _ref-tasks-checkpkg:
``do_checkpkg``
---------------
Provides information about the recipe including its upstream version and
status. The upstream version and status reveals whether or not a version
of the recipe exists upstream and a status of not updated, updated, or
unknown.
To check the upstream version and status of a recipe, use the following
devtool commands:
::
$ devtool latest-version
$ devtool check-upgrade-status
See the ":ref:`ref-manual/ref-devtool-reference:\`\`devtool\`\` quick reference`"
chapter for more information on
``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`"
section for information on checking the upgrade status of a recipe.
To build the ``checkpkg`` task, use the ``bitbake`` command with the
"-c" option and task name:
::
$ bitbake core-image-minimal -c checkpkg
By default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g.
``$BUILD_DIR/tmp/log``).
.. _ref-tasks-checkuri:
``do_checkuri``
---------------
Validates the :term:`SRC_URI` value.
.. _ref-tasks-clean:
``do_clean``
------------
Removes all output files for a target from the
:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``,
:ref:`ref-tasks-configure`,
:ref:`ref-tasks-compile`,
:ref:`ref-tasks-install`, and
:ref:`ref-tasks-package`).
You can run this task using BitBake as follows:
::
$ bitbake -c clean recipe
Running this task does not remove the
:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>` cache files.
Consequently, if no changes have been made and the recipe is rebuilt
after cleaning, output files are simply restored from the sstate cache.
If you want to remove the sstate cache files for the recipe, you need to
use the :ref:`ref-tasks-cleansstate` task instead
(i.e. ``bitbake -c cleansstate`` recipe).
.. _ref-tasks-cleanall:
``do_cleanall``
---------------
Removes all output files, shared state
(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, and
downloaded source files for a target (i.e. the contents of
:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is
identical to the :ref:`ref-tasks-cleansstate` task
with the added removal of downloaded source files.
You can run this task using BitBake as follows:
::
$ bitbake -c cleanall recipe
Typically, you would not normally use the ``cleanall`` task. Do so only
if you want to start fresh with the :ref:`ref-tasks-fetch`
task.
.. _ref-tasks-cleansstate:
``do_cleansstate``
------------------
Removes all output files and shared state
(:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a
target. Essentially, the ``do_cleansstate`` task is identical to the
:ref:`ref-tasks-clean` task with the added removal of
shared state (`:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`)
cache.
You can run this task using BitBake as follows:
::
$ bitbake -c cleansstate recipe
When you run the ``do_cleansstate`` task, the OpenEmbedded build system
no longer uses any sstate. Consequently, building the recipe from
scratch is guaranteed.
.. note::
The
do_cleansstate
task cannot remove sstate from a remote sstate mirror. If you need to
build a target from scratch using remote mirrors, use the "-f" option
as follows:
::
$ bitbake -f -c do_cleansstate target
.. _ref-tasks-devpyshell:
``do_devpyshell``
-----------------
Starts a shell in which an interactive Python interpreter allows you to
interact with the BitBake build environment. From within this shell, you
can directly examine and set bits from the data store and execute
functions as if within the BitBake environment. See the ":ref:`platdev-appdev-devpyshell`" section in
the Yocto Project Development Tasks Manual for more information about
using ``devpyshell``.
.. _ref-tasks-devshell:
``do_devshell``
---------------
Starts a shell whose environment is set up for development, debugging,
or both. See the ":ref:`platdev-appdev-devshell`" section in the
Yocto Project Development Tasks Manual for more information about using
``devshell``.
.. _ref-tasks-listtasks:
``do_listtasks``
----------------
Lists all defined tasks for a target.
.. _ref-tasks-package_index:
``do_package_index``
--------------------
Creates or updates the index in the `:ref:`package-feeds-dev-environment` area.
.. note::
This task is not triggered with the
bitbake -c
command-line option as are the other tasks in this section. Because
this task is specifically for the
package-index
recipe, you run it using
bitbake package-index
.
Image-Related Tasks
===================
The following tasks are applicable to image recipes.
.. _ref-tasks-bootimg:
``do_bootimg``
--------------
Creates a bootable live image. See the
:term:`IMAGE_FSTYPES` variable for additional
information on live image types.
.. _ref-tasks-bundle_initramfs:
``do_bundle_initramfs``
-----------------------
Combines an initial RAM disk (initramfs) image and kernel together to
form a single image. The
:term:`CONFIG_INITRAMFS_SOURCE` variable
has some more information about these types of images.
.. _ref-tasks-rootfs:
``do_rootfs``
-------------
Creates the root filesystem (file and directory structure) for an image.
See the ":ref:`image-generation-dev-environment`"
section in the Yocto Project Overview and Concepts Manual for more
information on how the root filesystem is created.
.. _ref-tasks-testimage:
``do_testimage``
----------------
Boots an image and performs runtime tests within the image. For
information on automatically testing images, see the
":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual.
.. _ref-tasks-testimage_auto:
``do_testimage_auto``
---------------------
Boots an image and performs runtime tests within the image immediately
after it has been built. This task is enabled when you set
:term:`TESTIMAGE_AUTO` equal to "1".
For information on automatically testing images, see the
":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual.
Kernel-Related Tasks
====================
The following tasks are applicable to kernel recipes. Some of these
tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
also applicable to recipes that use Linux kernel style configuration
such as the BusyBox recipe.
.. _ref-tasks-compile_kernelmodules:
``do_compile_kernelmodules``
----------------------------
Runs the step that builds the kernel modules (if needed). Building a
kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and
2) the modules are built (i.e. ``make modules``).
.. _ref-tasks-diffconfig:
``do_diffconfig``
-----------------
When invoked by the user, this task creates a file containing the
differences between the original config as produced by
:ref:`ref-tasks-kernel_configme` task and the
changes made by the user with other methods (i.e. using
(:ref:`ref-tasks-kernel_menuconfig`). Once the
file of differences is created, it can be used to create a config
fragment that only contains the differences. You can invoke this task
from the command line as follows:
::
$ bitbake linux-yocto -c diffconfig
For more information, see the
":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`"
section in the Yocto Project Linux Kernel Development Manual.
.. _ref-tasks-kernel_checkout:
``do_kernel_checkout``
----------------------
Converts the newly unpacked kernel source into a form with which the
OpenEmbedded build system can work. Because the kernel source can be
fetched in several different ways, the ``do_kernel_checkout`` task makes
sure that subsequent tasks are given a clean working tree copy of the
kernel with the correct branches checked out.
.. _ref-tasks-kernel_configcheck:
``do_kernel_configcheck``
-------------------------
Validates the configuration produced by the
:ref:`ref-tasks-kernel_menuconfig` task. The
``do_kernel_configcheck`` task produces warnings when a requested
configuration does not appear in the final ``.config`` file or when you
override a policy configuration in a hardware configuration fragment.
You can run this task explicitly and view the output by using the
following command:
::
$ bitbake linux-yocto -c kernel_configcheck -f
For more information, see the
":ref:`kernel-dev/kernel-dev-common:validating configuration`"
section in the Yocto Project Linux Kernel Development Manual.
.. _ref-tasks-kernel_configme:
``do_kernel_configme``
----------------------
After the kernel is patched by the :ref:`ref-tasks-patch`
task, the ``do_kernel_configme`` task assembles and merges all the
kernel config fragments into a merged configuration that can then be
passed to the kernel configuration phase proper. This is also the time
during which user-specified defconfigs are applied if present, and where
configuration modes such as ``--allnoconfig`` are applied.
.. _ref-tasks-kernel_menuconfig:
``do_kernel_menuconfig``
------------------------
Invoked by the user to manipulate the ``.config`` file used to build a
linux-yocto recipe. This task starts the Linux kernel configuration
tool, which you then use to modify the kernel configuration.
.. note::
You can also invoke this tool from the command line as follows:
::
$ bitbake linux-yocto -c menuconfig
See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``"
section in the Yocto Project Linux Kernel Development Manual for more
information on this configuration tool.
.. _ref-tasks-kernel_metadata:
``do_kernel_metadata``
----------------------
Collects all the features required for a given kernel build, whether the
features come from :term:`SRC_URI` or from Git
repositories. After collection, the ``do_kernel_metadata`` task
processes the features into a series of config fragments and patches,
which can then be applied by subsequent tasks such as
:ref:`ref-tasks-patch` and
:ref:`ref-tasks-kernel_configme`.
.. _ref-tasks-menuconfig:
``do_menuconfig``
-----------------
Runs ``make menuconfig`` for the kernel. For information on
``menuconfig``, see the
":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``"
section in the Yocto Project Linux Kernel Development Manual.
.. _ref-tasks-savedefconfig:
``do_savedefconfig``
--------------------
When invoked by the user, creates a defconfig file that can be used
instead of the default defconfig. The saved defconfig contains the
differences between the default defconfig and the changes made by the
user using other methods (i.e. the
:ref:`ref-tasks-kernel_menuconfig` task. You
can invoke the task using the following command:
::
$ bitbake linux-yocto -c savedefconfig
.. _ref-tasks-shared_workdir:
``do_shared_workdir``
---------------------
After the kernel has been compiled but before the kernel modules have
been compiled, this task copies files required for module builds and
which are generated from the kernel build into the shared work
directory. With these copies successfully copied, the
:ref:`ref-tasks-compile_kernelmodules` task
can successfully build the kernel modules in the next step of the build.
.. _ref-tasks-sizecheck:
``do_sizecheck``
----------------
After the kernel has been built, this task checks the size of the
stripped kernel image against
:term:`KERNEL_IMAGE_MAXSIZE`. If that
variable was set and the size of the stripped kernel exceeds that size,
the kernel build produces a warning to that effect.
.. _ref-tasks-strip:
``do_strip``
------------
If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips
the sections named in that variable from ``vmlinux``. This stripping is
typically used to remove nonessential sections such as ``.comment``
sections from a size-sensitive configuration.
.. _ref-tasks-validate_branches:
``do_validate_branches``
------------------------
After the kernel is unpacked but before it is patched, this task makes
sure that the machine and metadata branches as specified by the
:term:`SRCREV` variables actually exist on the specified
branches. If these branches do not exist and
:term:`AUTOREV` is not being used, the
``do_validate_branches`` task fails during the build.
Miscellaneous Tasks
===================
The following sections describe miscellaneous tasks.
.. _ref-tasks-spdx:
``do_spdx``
-----------
A build stage that takes the source code and scans it on a remote
FOSSOLOGY server in order to produce an SPDX document. This task applies
only to the :ref:`spdx <ref-classes-spdx>` class.
documentation/ref-manual/ref-tasks.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-tasks'>
<title>Tasks</title>
documentation/ref-manual/ref-terms.rst
+397
View File
@@ -0,0 +1,397 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
*******************
Yocto Project Terms
*******************
Following is a list of terms and definitions users new to the Yocto Project
development environment might find helpful. While some of these terms are
universal, the list includes them just in case:
.. glossary::
Append Files
Files that append build information to a recipe file. Append files are
known as BitBake append files and ``.bbappend`` files. The OpenEmbedded
build system expects every append file to have a corresponding recipe
(``.bb``) file. Furthermore, the append file and corresponding recipe file
must use the same root filename. The filenames can differ only in the
file type suffix used (e.g. ``formfactor_0.0.bb`` and
``formfactor_0.0.bbappend``).
Information in append files extends or overrides the information in the
similarly-named recipe file. For an example of an append file in use, see
the ":ref:`dev-manual/dev-manual-common-tasks:Using .bbappend Files in
Your Layer`" section in the Yocto Project Development Tasks Manual.
When you name an append file, you can use the "``%``" wildcard character
to allow for matching recipe names. For example, suppose you have an
append file named as follows:
::
busybox_1.21.%.bbappend
That append file
would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So,
the append file would match any of the following recipe names:
.. code-block:: shell
busybox_1.21.1.bb
busybox_1.21.2.bb
busybox_1.21.3.bb
busybox_1.21.10.bb
busybox_1.21.25.bb
.. note::
The use of the " % " character is limited in that it only works
directly in front of the .bbappend portion of the append file's
name. You cannot use the wildcard character in any other location of
the name.
BitBake
The task executor and scheduler used by the OpenEmbedded build system to
build images. For more information on BitBake, see the :doc:`BitBake User
Manual <bitbake:index>`.
Board Support Package (BSP)
A group of drivers, definitions, and other components that provide support
for a specific hardware configuration. For more information on BSPs, see
the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package
Developer's Guide`.
Build Directory
This term refers to the area used by the OpenEmbedded build system for
builds. The area is created when you ``source`` the setup environment
script that is found in the Source Directory
(i.e. :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``). The
:term:`TOPDIR` variable points to the Build Directory.
You have a lot of flexibility when creating the Build Directory.
Following are some examples that show how to create the directory. The
examples assume your :term:`Source Directory` is named ``poky``:
- Create the Build Directory inside your Source Directory and let
the name of the Build Directory default to ``build``:
.. code-block:: shell
$ cd $HOME/poky
$ source oe-init-build-env
- Create the Build Directory inside your home directory and
specifically name it ``test-builds``:
.. code-block:: shell
$ cd $HOME
$ source poky/oe-init-build-env test-builds
- Provide a directory path and specifically name the Build
Directory. Any intermediate folders in the pathname must exist.
This next example creates a Build Directory named
``YP-POKYVERSION`` in your home directory within the existing
directory ``mybuilds``:
.. code-block:: shell
$ cd $HOME
$ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION
.. note::
By default, the Build Directory contains :term:`TMPDIR` , which is a
temporary directory the build system uses for its work. TMPDIR cannot
be under NFS. Thus, by default, the Build Directory cannot be under
NFS. However, if you need the Build Directory to be under NFS, you can
set this up by setting TMPDIR in your local.conf file to use a local
drive. Doing so effectively separates TMPDIR from TOPDIR , which is the
Build Directory.
Build Host
The system used to build images in a Yocto Project Development
environment. The build system is sometimes referred to as the development
host.
Classes
Files that provide for logic encapsulation and inheritance so that
commonly used patterns can be defined once and then easily used in
multiple recipes. For reference information on the Yocto Project classes,
see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the
``.bbclass`` filename extension.
Configuration File
Files that hold global definitions of variables, user-defined variables,
and hardware configuration information. These files tell the OpenEmbedded
build system what to build and what to put into the image to support a
particular platform.
Configuration files end with a ``.conf`` filename extension. The
:file:`conf/local.conf` configuration file in the :term:`Build Directory`
contains user-defined variables that affect every build. The
:file:`meta-poky/conf/distro/poky.conf` configuration file defines Yocto
"distro" configuration variables used only when building with this
policy. Machine configuration files, which are located throughout the
:term:`Source Directory`, define variables for specific hardware and are
only used when building for that target (e.g. the
:file:`machine/beaglebone.conf` configuration file defines variables for
the Texas Instruments ARM Cortex-A8 development board).
Container Layer
Layers that hold other layers. An example of a container layer is
OpenEmbedded's `meta-openembedded
<https://github.com/openembedded/meta-openembedded>`_ layer. The
``meta-openembedded`` layer contains many ``meta-*`` layers.
Cross-Development Toolchain
In general, a cross-development toolchain is a collection of software
development tools and utilities that run on one architecture and allow you
to develop software for a different, or targeted, architecture. These
toolchains contain cross-compilers, linkers, and debuggers that are
specific to the target architecture.
The Yocto Project supports two different cross-development toolchains:
- A toolchain only used by and within BitBake when building an image for a
target architecture.
- A relocatable toolchain used outside of BitBake by developers when
developing applications that will run on a targeted device.
Creation of these toolchains is simple and automated. For information on
toolchain concepts as they apply to the Yocto Project, see the
":ref:`overview-manual/overview-manual-concepts:Cross-Development
Toolchain Generation`" section in the Yocto Project Overview and Concepts
Manual. You can also find more information on using the relocatable
toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application
Development and the Extensible Software Development Kit (eSDK)` manual.
Extensible Software Development Kit (eSDK)
A custom SDK for application developers. This eSDK allows developers to
incorporate their library and programming changes back into the image to
make their code available to other application developers.
For information on the eSDK, see the :ref:`sdk-manual/sdk-manual:Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK)` manual.
Image
An image is an artifact of the BitBake build process given a collection of
recipes and related Metadata. Images are the binary output that run on
specific hardware or QEMU and are used for specific use-cases. For a list
of the supported image types that the Yocto Project provides, see the
":ref:`ref-manual/ref-images:Images`" chapter.
Layer
A collection of related recipes. Layers allow you to consolidate related
metadata to customize your build. Layers also isolate information used
when building for multiple architectures. Layers are hierarchical in
their ability to override previous specifications. You can include any
number of available layers from the Yocto Project and customize the build
by adding your layers after them. You can search the Layer Index for
layers used within Yocto Project.
For introductory information on layers, see the
":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer
Model`" section in the Yocto Project Overview and Concepts Manual. For
more detailed information on layers, see the
":ref:`dev-manual/dev-manual-common-tasks:Understanding and Creating
Layers`" section in the Yocto Project Development Tasks Manual. For a
discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP
Layers`" section in the Yocto Project Board Support Packages (BSP)
Developer's Guide.
Metadata
A key element of the Yocto Project is the Metadata that
is used to construct a Linux distribution and is contained in the
files that the :term:`OpenEmbedded Build System`
parses when building an image. In general, Metadata includes recipes,
configuration files, and other information that refers to the build
instructions themselves, as well as the data used to control what
things get built and the effects of the build. Metadata also includes
commands and data used to indicate what versions of software are
used, from where they are obtained, and changes or additions to the
software itself (patches or auxiliary files) that are used to fix
bugs or customize the software for use in a particular situation.
OpenEmbedded-Core is an important set of validated metadata.
In the context of the kernel ("kernel Metadata"), the term refers to
the kernel config fragments and features contained in the
:yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache>`
Git repository.
OpenEmbedded-Core (OE-Core)
OE-Core is metadata comprised of
foundational recipes, classes, and associated files that are meant to
be common among many different OpenEmbedded-derived systems,
including the Yocto Project. OE-Core is a curated subset of an
original repository developed by the OpenEmbedded community that has
been pared down into a smaller, core set of continuously validated
recipes. The result is a tightly controlled and an quality-assured
core set of recipes.
You can see the Metadata in the ``meta`` directory of the Yocto
Project :yocto_git:`Source Repositories <>`.
OpenEmbedded Build System
The build system specific to the Yocto
Project. The OpenEmbedded build system is based on another project
known as "Poky", which uses :term:`BitBake` as the task
executor. Throughout the Yocto Project documentation set, the
OpenEmbedded build system is sometimes referred to simply as "the
build system". If other build systems, such as a host or target build
system are referenced, the documentation clearly states the
difference.
.. note::
For some historical information about Poky, see the
Poky
term.
Package
In the context of the Yocto Project, this term refers to a
recipe's packaged output produced by BitBake (i.e. a "baked recipe").
A package is generally the compiled binaries produced from the
recipe's sources. You "bake" something by running it through BitBake.
It is worth noting that the term "package" can, in general, have
subtle meanings. For example, the packages referred to in the
"`Required Packages for the Build
Host <#required-packages-for-the-build-host>`__" section are compiled
binaries that, when installed, add functionality to your Linux
distribution.
Another point worth noting is that historically within the Yocto
Project, recipes were referred to as packages - thus, the existence
of several BitBake variables that are seemingly mis-named, (e.g.
:term:`PR`, :term:`PV`, and
:term:`PE`).
Package Groups
Arbitrary groups of software Recipes. You use
package groups to hold recipes that, when built, usually accomplish a
single task. For example, a package group could contain the recipes
for a company's proprietary or value-add software. Or, the package
group could contain the recipes that enable graphics. A package group
is really just another recipe. Because package group files are
recipes, they end with the ``.bb`` filename extension.
Poky
Poky, which is pronounced *Pock*-ee, is a reference embedded
distribution and a reference test configuration. Poky provides the
following:
- A base-level functional distro used to illustrate how to customize
a distribution.
- A means by which to test the Yocto Project components (i.e. Poky
is used to validate the Yocto Project).
- A vehicle through which you can download the Yocto Project.
Poky is not a product level distro. Rather, it is a good starting
point for customization.
.. note::
Poky began as an open-source project initially developed by
OpenedHand. OpenedHand developed Poky from the existing
OpenEmbedded build system to create a commercially supportable
build system for embedded Linux. After Intel Corporation acquired
OpenedHand, the poky project became the basis for the Yocto
Project's build system.
Recipe
A set of instructions for building packages. A recipe
describes where you get source code, which patches to apply, how to
configure the source, how to compile it and so on. Recipes also
describe dependencies for libraries or for other recipes. Recipes
represent the logical unit of execution, the software to build, the
images to build, and use the ``.bb`` file extension.
Reference Kit
A working example of a system, which includes a
:term:`BSP<Board Support Package (BSP)>` as well as a
:term:`build host<Build Host>` and other components, that can
work on specific hardware.
Source Directory
This term refers to the directory structure
created as a result of creating a local copy of the ``poky`` Git
repository ``git://git.yoctoproject.org/poky`` or expanding a
released ``poky`` tarball.
.. note::
Creating a local copy of the
poky
Git repository is the recommended method for setting up your
Source Directory.
Sometimes you might hear the term "poky directory" used to refer to
this directory structure.
.. note::
The OpenEmbedded build system does not support file or directory
names that contain spaces. Be sure that the Source Directory you
use does not contain these types of names.
The Source Directory contains BitBake, Documentation, Metadata and
other files that all support the Yocto Project. Consequently, you
must have the Source Directory in place on your development system in
order to do any development using the Yocto Project.
When you create a local copy of the Git repository, you can name the
repository anything you like. Throughout much of the documentation,
"poky" is used as the name of the top-level folder of the local copy
of the poky Git repository. So, for example, cloning the ``poky`` Git
repository results in a local Git repository whose top-level folder
is also named "poky".
While it is not recommended that you use tarball expansion to set up
the Source Directory, if you do, the top-level directory name of the
Source Directory is derived from the Yocto Project release tarball.
For example, downloading and unpacking
:yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2`
results in a Source Directory whose root folder is named ``poky``.
It is important to understand the differences between the Source
Directory created by unpacking a released tarball as compared to
cloning ``git://git.yoctoproject.org/poky``. When you unpack a
tarball, you have an exact copy of the files based on the time of
release - a fixed release point. Any changes you make to your local
files in the Source Directory are on top of the release and will
remain local only. On the other hand, when you clone the ``poky`` Git
repository, you have an active development repository with access to
the upstream repository's branches and tags. In this case, any local
changes you make to the local Source Directory can be later applied
to active development branches of the upstream ``poky`` Git
repository.
For more information on concepts related to Git repositories,
branches, and tags, see the
":ref:`overview-manual/overview-manual-development-environment:repositories, tags, and branches`"
section in the Yocto Project Overview and Concepts Manual.
Task
A unit of execution for BitBake (e.g.
:ref:`ref-tasks-compile`,
:ref:`ref-tasks-fetch`,
:ref:`ref-tasks-patch`, and so forth).
Toaster
A web interface to the Yocto Project's :term:`OpenEmbedded Build System`.
The interface enables you to
configure and run your builds. Information about builds is collected
and stored in a database. For information on Toaster, see the
:doc:`../toaster-manual/toaster-manual`.
Upstream
A reference to source code or repositories that are not
local to the development system but located in a master area that is
controlled by the maintainer of the source code. For example, in
order for a developer to work on a particular piece of code, they
need to first get a copy of it from an "upstream" source.
documentation/ref-manual/ref-terms.xml
+2 -1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-terms'>
<title>Yocto Project Terms</title>
@@ -364,7 +365,7 @@
You use package groups to hold recipes that, when built,
usually accomplish a single task.
For example, a package group could contain the recipes for a
company’s proprietary or value-add software.
company's proprietary or value-add software.
Or, the package group could contain the recipes that enable
graphics.
A package group is really just another recipe.
documentation/ref-manual/ref-variables.rst
+8899
View File
File diff suppressed because it is too large Load Diff
documentation/ref-manual/ref-variables.xml
+178 -1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<!-- Dummy chapter -->
<chapter id='ref-variables-glos'>
@@ -4990,6 +4991,30 @@
</glossdef>
</glossentry>
<glossentry id='var-FIT_HASH_ALG'><glossterm>FIT_HASH_ALG</glossterm>
<info>
FIT_HASH_ALG[doc] = "Specifies the hash algorithm used in creating the FIT Image."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the hash algorithm used in creating the FIT Image.
For e.g. sha256.
</para>
</glossdef>
</glossentry>
<glossentry id='var-FIT_SIGN_ALG'><glossterm>FIT_SIGN_ALG</glossterm>
<info>
FIT_SIGN_ALG[doc] = "Specifies the signature algorithm used in creating the FIT Image."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the signature algorithm used in creating the FIT Image.
For e.g. rsa2048.
</para>
</glossdef>
</glossentry>
<glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm>FONT_EXTRA_RDEPENDS</glossterm>
<info>
FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'."
@@ -5702,7 +5727,7 @@
<para role="glossdeffirst">
A space-separated list of files installed into the
boot partition when preparing an image using the Wic tool
with the <filename>bootimg-partition</filename> source
with the <filename>bootimg-partition</filename> or <filename>bootimg-efi</filename> source
plugin.
By default, the files are installed under the same name as
the source files.
@@ -9539,6 +9564,40 @@
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_ADD_METADATA'><glossterm>PACKAGE_ADD_METADATA</glossterm>
<info>
PACKAGE_ADD_METADATA[doc] = "This variable defines additional metadata to add to packages."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
This variable defines additional metdata to add to packages.
</para>
<para>
You may find you need to inject additional metadata into
packages. This variable allows you to do that by setting
the injected data as the value. Multiple fields can be
added by splitting the content with the literal separator
"\n".
</para>
<para>
The suffixes '_IPK', '_DEB', or '_RPM' can be applied to
the variable to do package type specific settings. It can
also be made package specific by using the package name as
a suffix.
</para>
<para>
You can find out more about applying this variable in
the
"<ulink url='&YOCTO_DOCS_DEV_URL;#adding-custom-metadata-to-packages'>Adding custom metadata to packages</ulink>"
section in the Yocto Project Development Tasks Manual.
</para>
</glossdef>
</glossentry>
<glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
<info>
PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages."
@@ -15925,6 +15984,38 @@
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_DTB_LOADADDRESS'><glossterm>UBOOT_DTB_LOADADDRESS</glossterm>
<info>
UBOOT_DTB_LOADADDRESS[doc] = "Specifies the load address for the dtb."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the load address for the dtb image used by U-boot.
During FIT image creation, the
<filename>UBOOT_DTB_LOADADDRESS</filename> variable is used
in <filename>kernel-fitimage</filename> class to specify the
load address to be used in creating the dtb sections of
Image Tree Source for the FIT image.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_DTBO_LOADADDRESS'><glossterm>UBOOT_DTBO_LOADADDRESS</glossterm>
<info>
UBOOT_DTBO_LOADADDRESS[doc] = "Specifies the load address for the dtbo."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the load address for the dtbo image used by U-boot.
During FIT image creation, the
<filename>UBOOT_DTBO_LOADADDRESS</filename> variable is used
in <filename>kernel-fitimage</filename> class to specify the
load address to be used in creating the dtbo sections of
Image Tree Source for the FIT image.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm>
<info>
UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image."
@@ -16010,6 +16101,51 @@
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_MKIMAGE_DTCOPTS'><glossterm>UBOOT_MKIMAGE_DTCOPTS</glossterm>
<info>
UBOOT_MKIMAGE_DTCOPTS[doc] = "Options for the device tree compiler passed to mkimage '-D' feature."
</info>
<glossdef>
<para role="glossdeffirst">
Options for the device tree compiler passed to mkimage '-D'
feature while creating FIT image in
<filename>kernel-fitimage</filename> class.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_RD_LOADADDRESS'><glossterm>UBOOT_RD_LOADADDRESS</glossterm>
<info>
UBOOT_RD_LOADADDRESS[doc] = "Specifies the load address for the ramdisk image."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the load address for the RAM disk image.
During FIT image creation, the
<filename>UBOOT_RD_LOADADDRESS</filename> variable is used
in <filename>kernel-fitimage</filename> class to specify the
load address to be used in creating the Image Tree Source for
the FIT image.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_RD_ENTRYPOINT'><glossterm>UBOOT_RD_ENTRYPOINT</glossterm>
<info>
UBOOT_RD_ENTRYPOINT[doc] = "Specifies the entrypoint for the ramdisk image."
</info>
<glossdef>
<para role="glossdeffirst">
Specifies the entrypoint for the RAM disk image.
During FIT image creation, the
<filename>UBOOT_RD_ENTRYPOINT</filename> variable is used
in <filename>kernel-fitimage</filename> class to specify the
entrypoint to be used in creating the Image Tree Source for
the FIT image.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_SUFFIX'><glossterm>UBOOT_SUFFIX</glossterm>
<info>
UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension."
@@ -16028,6 +16164,47 @@
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_SIGN_ENABLE'><glossterm>UBOOT_SIGN_ENABLE</glossterm>
<info>
UBOOT_SIGN_KEYDIR[doc] = "Enable signing of FIT image."
</info>
<glossdef>
<para role="glossdeffirst">
Enable signing of FIT image. The default value is "0".
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_SIGN_KEYDIR'><glossterm>UBOOT_SIGN_KEYDIR</glossterm>
<info>
UBOOT_SIGN_KEYDIR[doc] = "Location of the directory containing the RSA key and certificate used for signing FIT image."
</info>
<glossdef>
<para role="glossdeffirst">
Location of the directory containing the RSA key and
certificate used for signing FIT image.
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_SIGN_KEYNAME'><glossterm>UBOOT_SIGN_KEYNAME</glossterm>
<info>
UBOOT_SIGN_KEYNAME[doc] = "The name of keys used for signing U-boot FIT image"
</info>
<glossdef>
<para role="glossdeffirst">
The name of keys used for signing U-boot FIT image stored in
<filename><link linkend='var-UBOOT_SIGN_KEYDIR'>UBOOT_SIGN_KEYDIR</link></filename>
directory. For e.g. dev.key key and dev.crt certificate
stored in
<filename><link linkend='var-UBOOT_SIGN_KEYDIR'>UBOOT_SIGN_KEYDIR</link></filename>
directory will have
<filename><link linkend='var-UBOOT_SIGN_KEYNAME'>UBOOT_SIGN_KEYNAME</link></filename>
set to "dev".
</para>
</glossdef>
</glossentry>
<glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm>
<info>
UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot."
documentation/ref-manual/ref-varlocality.rst
+166
View File
@@ -0,0 +1,166 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
****************
Variable Context
****************
While you can use most variables in almost any context such as
``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are
often associated with a particular locality or context. This chapter
describes some common associations.
.. _ref-varlocality-configuration:
Configuration
=============
The following subsections provide lists of variables whose context is
configuration: distribution, machine, and local.
.. _ref-varlocality-config-distro:
Distribution (Distro)
---------------------
This section lists variables whose configuration context is the
distribution, or distro.
- :term:`DISTRO`
- :term:`DISTRO_NAME`
- :term:`DISTRO_VERSION`
- :term:`MAINTAINER`
- :term:`PACKAGE_CLASSES`
- :term:`TARGET_OS`
- :term:`TARGET_FPU`
- :term:`TCMODE`
- :term:`TCLIBC`
.. _ref-varlocality-config-machine:
Machine
-------
This section lists variables whose configuration context is the machine.
- :term:`TARGET_ARCH`
- :term:`SERIAL_CONSOLES`
- :term:`PACKAGE_EXTRA_ARCHS`
- :term:`IMAGE_FSTYPES`
- :term:`MACHINE_FEATURES`
- :term:`MACHINE_EXTRA_RDEPENDS`
- :term:`MACHINE_EXTRA_RRECOMMENDS`
- :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
- :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
.. _ref-varlocality-config-local:
Local
-----
This section lists variables whose configuration context is the local
configuration through the ``local.conf`` file.
- :term:`DISTRO`
- :term:`MACHINE`
- :term:`DL_DIR`
- :term:`BBFILES`
- :term:`EXTRA_IMAGE_FEATURES`
- :term:`PACKAGE_CLASSES`
- :term:`BB_NUMBER_THREADS`
- :term:`BBINCLUDELOGS`
- :term:`ENABLE_BINARY_LOCALE_GENERATION`
.. _ref-varlocality-recipes:
Recipes
=======
The following subsections provide lists of variables whose context is
recipes: required, dependencies, path, and extra build information.
.. _ref-varlocality-recipe-required:
Required
--------
This section lists variables that are required for recipes.
- :term:`LICENSE`
- :term:`LIC_FILES_CHKSUM`
- :term:`SRC_URI` - used in recipes that fetch local or remote files.
.. _ref-varlocality-recipe-dependencies:
Dependencies
------------
This section lists variables that define recipe dependencies.
- :term:`DEPENDS`
- :term:`RDEPENDS`
- :term:`RRECOMMENDS`
- :term:`RCONFLICTS`
- :term:`RREPLACES`
.. _ref-varlocality-recipe-paths:
Paths
-----
This section lists variables that define recipe paths.
- :term:`WORKDIR`
- :term:`S`
- :term:`FILES`
.. _ref-varlocality-recipe-build:
Extra Build Information
-----------------------
This section lists variables that define extra build information for
recipes.
- :term:`DEFAULT_PREFERENCE`
- :term:`EXTRA_OECMAKE`
- :term:`EXTRA_OECONF`
- :term:`EXTRA_OEMAKE`
- :term:`PACKAGECONFIG_CONFARGS`
- :term:`PACKAGES`
documentation/ref-manual/ref-varlocality.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='ref-varlocality'>
<title>Variable Context</title>
documentation/ref-manual/resources.rst
+197
View File
@@ -0,0 +1,197 @@
.. SPDX-License-Identifier: CC-BY-2.0-UK
****************************************
Contributions and Additional Information
****************************************
.. _resources-intro:
Introduction
============
The Yocto Project team is happy for people to experiment with the Yocto
Project. A number of places exist to find help if you run into
difficulties or find bugs. This presents information about contributing
and participating in the Yocto Project.
.. _resources-contributions:
Contributions
=============
The Yocto Project gladly accepts contributions. You can submit changes
to the project either by creating and sending pull requests, or by
submitting patches through email. For information on how to do both as
well as information on how to identify the maintainer for each area of
code, see the ":ref:`how-to-submit-a-change`" section in the
Yocto Project Development Tasks Manual.
.. _resources-bugtracker:
Yocto Project Bugzilla
======================
The Yocto Project uses its own implementation of
:yocto_bugs:`Bugzilla <>` to track defects (bugs).
Implementations of Bugzilla work well for group development because they
track bugs and code changes, can be used to communicate changes and
problems with developers, can be used to submit and review patches, and
can be used to manage quality assurance.
Sometimes it is helpful to submit, investigate, or track a bug against
the Yocto Project itself (e.g. when discovering an issue with some
component of the build system that acts contrary to the documentation or
your expectations).
A general procedure and guidelines exist for when you use Bugzilla to
submit a bug. For information on how to use Bugzilla to submit a bug
against the Yocto Project, see the following:
- The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`"
section in the Yocto Project Development Tasks Manual.
- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
For information on Bugzilla in general, see http://www.bugzilla.org/about/.
.. _resources-mailinglist:
Mailing lists
=============
A number of mailing lists maintained by the Yocto Project exist as well
as related OpenEmbedded mailing lists for discussion, patch submission
and announcements. To subscribe to one of the following mailing lists,
click on the appropriate URL in the following list and follow the
instructions:
- https://lists.yoctoproject.org/g/yocto - General Yocto Project
discussion mailing list.
- https://lists.openembedded.org/g/openembedded-core - Discussion mailing
list about OpenEmbedded-Core (the core metadata).
- https://lists.openembedded.org/g/openembedded-devel - Discussion
mailing list about OpenEmbedded.
- https://lists.openembedded.org/g/bitbake-devel - Discussion mailing
list about the :term:`BitBake` build tool.
- https://lists.yoctoproject.org/g/poky - Discussion mailing list
about `Poky <#poky>`__.
- https://lists.yoctoproject.org/g/yocto-announce - Mailing list to
receive official Yocto Project release and milestone announcements.
For more Yocto Project-related mailing lists, see the
Yocto Project Website
.
.. _resources-irc:
Internet Relay Chat (IRC)
=========================
Two IRC channels on freenode are available for the Yocto Project and
Poky discussions:
- ``#yocto``
- ``#poky``
.. _resources-links-and-related-documentation:
Links and Related Documentation
===============================
Here is a list of resources you might find helpful:
- :yocto_home:`The Yocto Project Website <>`\ *:* The home site
for the Yocto Project.
- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for
the Yocto Project. This page contains information about project
planning, release engineering, QA & automation, a reference site map,
and other resources related to the Yocto Project.
- `OpenEmbedded <http://www.openembedded.org/>`__\ *:* The build system used by the
Yocto Project. This project is the upstream, generic, embedded
distribution from which the Yocto Project derives its build system
(Poky) and to which it contributes.
- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool
used to process metadata.
- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
guide to the BitBake tool. If you want information on BitBake, see
this manual.
- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This
short document lets you experience building an image using the Yocto
Project without having to understand any concepts or details.
- :doc:`../overview-manual/overview-manual` *:* This manual provides overview
and conceptual information about the Yocto Project.
- :doc:`../dev-manual/dev-manual` *:* This manual is a "how-to" guide
that presents procedures useful to both application and system
developers who use the Yocto Project.
- :doc:`../sdk-manual/sdk-manual` *manual :* This
guide provides information that lets you get going with the standard
or extensible SDK. An SDK, with its cross-development toolchains,
allows you to develop projects inside or outside of the Yocto Project
environment.
- :doc:`../bsp-guide/bsp` *:* This guide defines the structure
for BSP components. Having a commonly understood structure encourages
standardization.
- :doc:`../kernel-dev/kernel-dev` *:* This manual describes
how to work with Linux Yocto kernels as well as provides a bit of
conceptual information on the construction of the Yocto Linux kernel
tree.
- :doc:`../ref-manual/ref-manual` *:* This
manual provides reference material such as variable, task, and class
descriptions.
- `Yocto Project Mega-Manual <https://docs.yoctoproject.org/singleindex.html>`__\ *:* This manual
is simply a single HTML file comprised of the bulk of the Yocto
Project manuals. The Mega-Manual primarily exists as a vehicle by
which you can easily search for phrases and terms used in the Yocto
Project documentation set.
- :doc:`../profile-manual/profile-manual` *:* This manual presents a set of
common and generally useful tracing and profiling schemes along with
their applications (as appropriate) to each tool.
- :doc:`../toaster-manual/toaster-manual` *:* This manual
introduces and describes how to set up and use Toaster. Toaster is an
Application Programming Interface (API) and web-based interface to
the :term:`OpenEmbedded Build System`, which uses
BitBake, that reports build information.
- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked
questions and their answers.
- *Release Notes:* Features, updates and known issues for the current
release of the Yocto Project. To access the Release Notes, go to the
:yocto_home:`Downloads </software-overview/downloads>` page on
the Yocto Project website and click on the "RELEASE INFORMATION" link
for the appropriate release.
- `Bugzilla <https://bugzilla.yoctoproject.org>`__\ *:* The bug tracking application
the Yocto Project uses. If you find problems with the Yocto Project,
you should report them using this application.
- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:*
Information on how to get set up and use the Yocto Project
implementation of Bugzilla for logging and tracking Yocto Project
defects.
- *Internet Relay Chat (IRC):* Two IRC channels on freenode are
available for Yocto Project and Poky discussions: ``#yocto`` and
``#poky``, respectively.
- `Quick EMUlator (QEMU) <http://wiki.qemu.org/Index.html>`__\ *:* An
open-source machine emulator and virtualizer.
documentation/ref-manual/resources.xml
+1
View File
@@ -1,6 +1,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
<chapter id='resources'>
<title>Contributions and Additional Information</title>