Yocto Project Reference Manual
- 1 System Requirements
- 2 Yocto Project Terms
- 3 Yocto Project Releases and the Stable Release Process
- 4 Source Directory Structure
- 4.1 Top-Level Core Components
- 4.2 The Build Directory —
build/
- 4.2.1
build/buildhistory/
- 4.2.2
build/conf/local.conf
- 4.2.3
build/conf/bblayers.conf
- 4.2.4
build/cache/sanity_info
- 4.2.5
build/downloads/
- 4.2.6
build/sstate-cache/
- 4.2.7
build/tmp/
- 4.2.8
build/tmp/buildstats/
- 4.2.9
build/tmp/cache/
- 4.2.10
build/tmp/deploy/
- 4.2.11
build/tmp/deploy/deb/
- 4.2.12
build/tmp/deploy/rpm/
- 4.2.13
build/tmp/deploy/ipk/
- 4.2.14
build/tmp/deploy/licenses/
- 4.2.15
build/tmp/deploy/images/
- 4.2.16
build/tmp/deploy/sdk/
- 4.2.17
build/tmp/sstate-control/
- 4.2.18
build/tmp/sysroots-components/
- 4.2.19
build/tmp/sysroots/
- 4.2.20
build/tmp/stamps/
- 4.2.21
build/tmp/log/
- 4.2.22
build/tmp/work/
- 4.2.23
build/tmp/work/tunearch/recipename/version/
- 4.2.24
build/tmp/work-shared/
- 4.2.1
- 4.3 The Metadata —
meta/
- 4.3.1
meta/classes/
- 4.3.2
meta/conf/
- 4.3.3
meta/conf/machine/
- 4.3.4
meta/conf/distro/
- 4.3.5
meta/conf/machine-sdk/
- 4.3.6
meta/files/
- 4.3.7
meta/lib/
- 4.3.8
meta/recipes-bsp/
- 4.3.9
meta/recipes-connectivity/
- 4.3.10
meta/recipes-core/
- 4.3.11
meta/recipes-devtools/
- 4.3.12
meta/recipes-extended/
- 4.3.13
meta/recipes-gnome/
- 4.3.14
meta/recipes-graphics/
- 4.3.15
meta/recipes-kernel/
- 4.3.16
meta/recipes-multimedia/
- 4.3.17
meta/recipes-rt/
- 4.3.18
meta/recipes-sato/
- 4.3.19
meta/recipes-support/
- 4.3.20
meta/site/
- 4.3.21
meta/recipes.txt
- 4.3.1
- 5 Classes
- 5.1
allarch
- 5.2
archiver
- 5.3
autotools*
- 5.4
base
- 5.5
bash-completion
- 5.6
bin_package
- 5.7
binconfig
- 5.8
binconfig-disabled
- 5.9
buildhistory
- 5.10
buildstats
- 5.11
buildstats-summary
- 5.12
cargo
- 5.13
cargo_common
- 5.14
ccache
- 5.15
chrpath
- 5.16
cmake
- 5.17
cml1
- 5.18
compress_doc
- 5.19
copyleft_compliance
- 5.20
copyleft_filter
- 5.21
core-image
- 5.22
cpan*
- 5.23
create-spdx
- 5.24
cross
- 5.25
cross-canadian
- 5.26
crosssdk
- 5.27
cve-check
- 5.28
debian
- 5.29
deploy
- 5.30
devicetree
- 5.31
devshell
- 5.32
devupstream
- 5.33
externalsrc
- 5.34
extrausers
- 5.35
features_check
- 5.36
fontcache
- 5.37
fs-uuid
- 5.38
gconf
- 5.39
gettext
- 5.40
gnomebase
- 5.41
go
- 5.42
go-mod
- 5.43
gobject-introspection
- 5.44
grub-efi
- 5.45
gsettings
- 5.46
gtk-doc
- 5.47
gtk-icon-cache
- 5.48
gtk-immodules-cache
- 5.49
gzipnative
- 5.50
icecc
- 5.51
image
- 5.52
image-buildinfo
- 5.53
image_types
- 5.54
image-live
- 5.55
insane
- 5.56
kernel
- 5.57
kernel-arch
- 5.58
kernel-devicetree
- 5.59
kernel-fitimage
- 5.60
kernel-grub
- 5.61
kernel-module-split
- 5.62
kernel-uboot
- 5.63
kernel-uimage
- 5.64
kernel-yocto
- 5.65
kernelsrc
- 5.66
lib_package
- 5.67
libc*
- 5.68
license
- 5.69
linux-kernel-base
- 5.70
linuxloader
- 5.71
logging
- 5.72
meson
- 5.73
metadata_scm
- 5.74
migrate_localcount
- 5.75
mime
- 5.76
mime-xdg
- 5.77
mirrors
- 5.78
module
- 5.79
module-base
- 5.80
multilib*
- 5.81
native
- 5.82
nativesdk
- 5.83
nopackages
- 5.84
npm
- 5.85
oelint
- 5.86
overlayfs
- 5.87
overlayfs-etc
- 5.88
own-mirrors
- 5.89
package
- 5.90
package_deb
- 5.91
package_ipk
- 5.92
package_rpm
- 5.93
package_tar
- 5.94
packagedata
- 5.95
packagegroup
- 5.96
patch
- 5.97
perlnative
- 5.98
pypi
- 5.99
python_flit_core
- 5.100
python_pep517
- 5.101
python_poetry_core
- 5.102
python_pyo3
- 5.103
python-setuptools3_rust
- 5.104
pixbufcache
- 5.105
pkgconfig
- 5.106
populate_sdk
- 5.107
populate_sdk_*
- 5.108
prexport
- 5.109
primport
- 5.110
prserv
- 5.111
ptest
- 5.112
ptest-gnome
- 5.113
python3-dir
- 5.114
python3native
- 5.115
python3targetconfig
- 5.116
qemu
- 5.117
recipe_sanity
- 5.118
relocatable
- 5.119
remove-libtool
- 5.120
report-error
- 5.121
rm_work
- 5.122
rootfs*
- 5.123
rust
- 5.124
rust-common
- 5.125
sanity
- 5.126
scons
- 5.127
sdl
- 5.128
python_setuptools_build_meta
- 5.129
setuptools3
- 5.130
setuptools3_legacy
- 5.131
setuptools3-base
- 5.132
sign_rpm
- 5.133
siteconfig
- 5.134
siteinfo
- 5.135
sstate
- 5.136
staging
- 5.137
syslinux
- 5.138
systemd
- 5.139
systemd-boot
- 5.140
terminal
- 5.141
testimage
- 5.142
testsdk
- 5.143
texinfo
- 5.144
toaster
- 5.145
toolchain-scripts
- 5.146
typecheck
- 5.147
uboot-config
- 5.148
uboot-sign
- 5.149
uninative
- 5.150
update-alternatives
- 5.151
update-rc.d
- 5.152
useradd*
- 5.153
utility-tasks
- 5.154
utils
- 5.155
vala
- 5.156
waf
- 5.1
- 6 Tasks
- 6.1 Normal Recipe Build Tasks
- 6.1.1
do_build
- 6.1.2
do_compile
- 6.1.3
do_compile_ptest_base
- 6.1.4
do_configure
- 6.1.5
do_configure_ptest_base
- 6.1.6
do_deploy
- 6.1.7
do_fetch
- 6.1.8
do_image
- 6.1.9
do_image_complete
- 6.1.10
do_install
- 6.1.11
do_install_ptest_base
- 6.1.12
do_package
- 6.1.13
do_package_qa
- 6.1.14
do_package_write_deb
- 6.1.15
do_package_write_ipk
- 6.1.16
do_package_write_rpm
- 6.1.17
do_package_write_tar
- 6.1.18
do_packagedata
- 6.1.19
do_patch
- 6.1.20
do_populate_lic
- 6.1.21
do_populate_sdk
- 6.1.22
do_populate_sdk_ext
- 6.1.23
do_populate_sysroot
- 6.1.24
do_prepare_recipe_sysroot
- 6.1.25
do_rm_work
- 6.1.26
do_unpack
- 6.1.1
- 6.2 Manually Called Tasks
- 6.3 Image-Related Tasks
- 6.4 Kernel-Related Tasks
- 6.4.1
do_compile_kernelmodules
- 6.4.2
do_diffconfig
- 6.4.3
do_kernel_checkout
- 6.4.4
do_kernel_configcheck
- 6.4.5
do_kernel_configme
- 6.4.6
do_kernel_menuconfig
- 6.4.7
do_kernel_metadata
- 6.4.8
do_menuconfig
- 6.4.9
do_savedefconfig
- 6.4.10
do_shared_workdir
- 6.4.11
do_sizecheck
- 6.4.12
do_strip
- 6.4.13
do_validate_branches
- 6.4.1
- 6.1 Normal Recipe Build Tasks
- 7
devtool
Quick Reference- 7.1 Getting Help
- 7.2 The Workspace Layer Structure
- 7.3 Adding a New Recipe to the Workspace Layer
- 7.4 Extracting the Source for an Existing Recipe
- 7.5 Synchronizing a Recipe’s Extracted Source Tree
- 7.6 Modifying an Existing Recipe
- 7.7 Edit an Existing Recipe
- 7.8 Updating a Recipe
- 7.9 Checking on the Upgrade Status of a Recipe
- 7.10 Upgrading a Recipe
- 7.11 Resetting a Recipe
- 7.12 Building Your Recipe
- 7.13 Building Your Image
- 7.14 Deploying Your Software on the Target Machine
- 7.15 Removing Your Software from the Target Machine
- 7.16 Creating the Workspace Layer in an Alternative Location
- 7.17 Get the Status of the Recipes in Your Workspace
- 7.18 Search for Available Target Recipes
- 8 OpenEmbedded Kickstart (
.wks
) Reference - 9 QA Error and Warning Messages
- 10 Images
- 11 Features
- 12 Variables Glossary
- 13 Variable Context
- 14 FAQ
- 15 Contributions and Additional Information
The Yocto Project ®
Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons.
To report any inaccuracies or problems with this (or any other Yocto Project)
manual, or to send additions or changes, please send email/patches to the Yocto
Project documentation mailing list at docs@lists.yoctoproject.org
or
log into the Libera Chat #yocto
channel.