blob: f9cb8aa77d1c0218b280a422dbd92e915543be1f [file] [log] [blame]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001#
2# This file is your local configuration file and is where all local user settings
3# are placed. The comments in this file give some guide to the options a new user
4# to the system might want to change but pretty much any configuration option can
Andrew Geissler9aee5002022-03-30 16:27:02 +00005# be set in this file. More adventurous users can look at
6# local.conf.sample.extended which contains other examples of configuration which
7# can be placed in this file but new users likely won't need any of them
Patrick Williamsdb4c27e2022-08-05 08:10:29 -05008# initially. There's also site.conf.sample which contains examples of site specific
9# information such as proxy server addresses.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050010#
11# Lines starting with the '#' character are commented out and in some cases the
12# default values are provided as comments to show people example syntax. Enabling
13# the option is a question of removing the # character and making any change to the
14# variable as required.
15
16#
17# Machine Selection
18#
19# You need to select a specific machine to target the build with. There are a selection
20# of emulated machines available which can boot and run in the QEMU emulator:
21#
22#MACHINE ?= "qemuarm"
23#MACHINE ?= "qemuarm64"
24#MACHINE ?= "qemumips"
25#MACHINE ?= "qemumips64"
26#MACHINE ?= "qemuppc"
27#MACHINE ?= "qemux86"
28#MACHINE ?= "qemux86-64"
29#
30# There are also the following hardware board target machines included for
31# demonstration purposes:
32#
Brad Bishop316dfdd2018-06-25 12:45:53 -040033#MACHINE ?= "beaglebone-yocto"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050034#MACHINE ?= "genericx86"
35#MACHINE ?= "genericx86-64"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050036#MACHINE ?= "edgerouter"
37#
Brad Bishop15ae2502019-06-18 21:44:24 -040038# This sets the default machine to be qemux86-64 if no other machine is selected:
39MACHINE ??= "qemux86-64"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050040
Andrew Geissler615f2f12022-07-15 14:00:58 -050041# These are some of the more commonly used values. Looking at the files in the
42# meta/conf/machine directory, or the conf/machine directory of any additional layers
43# you add in will show all the available machines.
44
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050045#
46# Where to place downloads
47#
48# During a first build the system will download many different source code tarballs
49# from various upstream projects. This can take a while, particularly if your network
50# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
51# can preserve this directory to speed up this part of subsequent builds. This directory
52# is safe to share between multiple builds on the same machine too.
53#
54# The default is a downloads directory under TOPDIR which is the build directory.
55#
56#DL_DIR ?= "${TOPDIR}/downloads"
57
58#
59# Where to place shared-state files
60#
61# BitBake has the capability to accelerate builds based on previously built output.
62# This is done using "shared state" files which can be thought of as cache objects
63# and this option determines where those files are placed.
64#
65# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
66# from these files if no changes were made to the configuration. If changes were made
67# to the configuration, only shared state files where the state was still valid would
68# be used (done using checksums).
69#
70# The default is a sstate-cache directory under TOPDIR.
71#
72#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
73
74#
75# Where to place the build output
76#
77# This option specifies where the bulk of the building work should be done and
78# where BitBake should place its temporary files and output. Keep in mind that
79# this includes the extraction and compilation of many applications and the toolchain
80# which can use Gigabytes of hard disk space.
81#
82# The default is a tmp directory under TOPDIR.
83#
84#TMPDIR = "${TOPDIR}/tmp"
85
86#
87# Default policy config
88#
89# The distribution setting controls which policy settings are used as defaults.
90# The default value is fine for general Yocto project use, at least initially.
91# Ultimately when creating custom policy, people will likely end up subclassing
92# these defaults.
93#
94DISTRO ?= "poky"
95# As an example of a subclass there is a "bleeding" edge policy configuration
96# where many versions are set to the absolute latest code from the upstream
97# source control systems. This is just mentioned here as an example, its not
98# useful to most new users.
99# DISTRO ?= "poky-bleeding"
100
101#
102# Package Management configuration
103#
104# This variable lists which packaging formats to enable. Multiple package backends
105# can be enabled at once and the first item listed in the variable will be used
106# to generate the root filesystems.
107# Options are:
108# - 'package_deb' for debian style deb files
109# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
110# - 'package_rpm' for rpm style packages
111# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
Patrick Williams03907ee2022-05-01 06:28:52 -0500112# OE-Core defaults to ipkg, whilst Poky defaults to rpm:
113# PACKAGE_CLASSES ?= "package_rpm"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500114
115#
116# SDK target architecture
117#
118# This variable specifies the architecture to build SDK items for and means
119# you can build the SDK packages for architectures other than the machine you are
120# running the build on (i.e. building i686 packages on an x86_64 host).
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600121# Supported values are i686, x86_64, aarch64
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500122#SDKMACHINE ?= "i686"
123
124#
125# Extra image configuration defaults
126#
127# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
128# images. Some of these options are added to certain image types automatically. The
129# variable can contain the following options:
130# "dbg-pkgs" - add -dbg packages for all installed packages
131# (adds symbol information for debugging/profiling)
Brad Bishop19323692019-04-05 15:28:33 -0400132# "src-pkgs" - add -src packages for all installed packages
133# (adds source code for debugging)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500134# "dev-pkgs" - add -dev packages for all installed packages
135# (useful if you want to develop against libs in the image)
136# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
137# (useful if you want to run the package test suites)
138# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
139# "tools-debug" - add debugging tools (gdb, strace)
140# "eclipse-debug" - add Eclipse remote debugging support
141# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
142# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
143# "debug-tweaks" - make an image suitable for development
144# e.g. ssh root access has a blank password
145# There are other application targets that can be used here too, see
Andrew Geissler517393d2023-01-13 08:55:19 -0600146# meta/classes-recipe/image.bbclass and
147# meta/classes-recipe/core-image.bbclass for more details.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500148# We default to enabling the debugging tweaks.
149EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
150
151#
152# Additional image features
153#
154# The following is a list of additional classes to use when building images which
155# enable extra features. Some available options which can be included in this variable
156# are:
157# - 'buildstats' collect build statistics
Patrick Williams213cb262021-08-07 19:21:33 -0500158USER_CLASSES ?= "buildstats"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500159
160#
161# Runtime testing of images
162#
163# The build system can test booting virtual machine images under qemu (an emulator)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300164# after any root filesystems are created and run tests against those images. It can also
165# run tests against any SDK that are built. To enable this uncomment these lines.
Andrew Geissler517393d2023-01-13 08:55:19 -0600166# See meta/classes-recipe/test{image,sdk}.bbclass for further details.
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300167#IMAGE_CLASSES += "testimage testsdk"
Andrew Geisslerd159c7f2021-09-02 21:05:58 -0500168#TESTIMAGE_AUTO:qemuall = "1"
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300169
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500170#
171# Interactive shell configuration
172#
173# Under certain circumstances the system may need input from you and to do this it
174# can launch an interactive shell. It needs to do this since the build is
175# multithreaded and needs to be able to handle the case where more than one parallel
176# process may require the user's attention. The default is iterate over the available
177# terminal types to find one that works.
178#
179# Examples of the occasions this may happen are when resolving patches which cannot
180# be applied, to use the devshell or the kernel menuconfig
181#
182# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
183# Note: currently, Konsole support only works for KDE 3.x due to the way
184# newer Konsole versions behave
185#OE_TERMINAL = "auto"
186# By default disable interactive patch resolution (tasks will just fail instead):
187PATCHRESOLVE = "noop"
188
189#
190# Disk Space Monitoring during the build
191#
192# Monitor the disk space during the build. If there is less that 1GB of space or less
193# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
Andrew Geissler7e0e3c02022-02-25 20:34:39 +0000194# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard halt
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500195# of the build. The reason for this is that running completely out of space can corrupt
196# files and damages the build in ways which may not be easily recoverable.
Andrew Geisslerf0343792020-11-18 10:42:21 -0600197# It's necessary to monitor /tmp, if there is no space left the build will fail
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500198# with very exotic errors.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500199BB_DISKMON_DIRS ??= "\
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500200 STOPTASKS,${TMPDIR},1G,100K \
201 STOPTASKS,${DL_DIR},1G,100K \
202 STOPTASKS,${SSTATE_DIR},1G,100K \
203 STOPTASKS,/tmp,100M,100K \
Andrew Geissler7e0e3c02022-02-25 20:34:39 +0000204 HALT,${TMPDIR},100M,1K \
205 HALT,${DL_DIR},100M,1K \
206 HALT,${SSTATE_DIR},100M,1K \
207 HALT,/tmp,10M,1K"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500208
209#
210# Shared-state files from other locations
211#
Andrew Geissler95ac1b82021-03-31 14:34:31 -0500212# As mentioned above, shared state files are prebuilt cache data objects which can be
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500213# used to accelerate build time. This variable can be used to configure the system
214# to search other mirror locations for these objects before it builds the data itself.
215#
Andrew Geissler9aee5002022-03-30 16:27:02 +0000216# This can be a filesystem directory, or a remote url such as https or ftp. These
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500217# would contain the sstate-cache results from previous builds (possibly from other
218# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
219# cache locations to check for the shared objects.
220# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
221# at the end as shown in the examples below. This will be substituted with the
222# correct path within the directory structure.
223#SSTATE_MIRRORS ?= "\
Andrew Geissler9aee5002022-03-30 16:27:02 +0000224#file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500225#file://.* file:///some/local/dir/sstate/PATH"
226
Brad Bishop316dfdd2018-06-25 12:45:53 -0400227#
228# Yocto Project SState Mirror
229#
230# The Yocto Project has prebuilt artefacts available for its releases, you can enable
Andrew Geissler5199d832021-09-24 16:47:35 -0500231# use of these by uncommenting the following lines. This will mean the build uses
Brad Bishop316dfdd2018-06-25 12:45:53 -0400232# the network to check for artefacts at the start of builds, which does slow it down
233# equally, it will also speed up the builds by not having to build things if they are
234# present in the cache. It assumes you can download something faster than you can build it
235# which will depend on your network.
Andrew Geissler5199d832021-09-24 16:47:35 -0500236# Note: For this to work you also need hash-equivalence passthrough to the matching server
Brad Bishop316dfdd2018-06-25 12:45:53 -0400237#
Andrew Geissler87f5cff2022-09-30 13:13:31 -0500238#BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687"
Andrew Geissler615f2f12022-07-15 14:00:58 -0500239#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500240
241#
242# Qemu configuration
243#
Brad Bishop08902b02019-08-20 09:16:51 -0400244# By default native qemu will build with a builtin VNC server where graphical output can be
Brad Bishop79641f22019-09-10 07:20:22 -0400245# seen. The line below enables the SDL UI frontend too.
Patrick Williams213cb262021-08-07 19:21:33 -0500246PACKAGECONFIG:append:pn-qemu-system-native = " sdl"
Brad Bishop79641f22019-09-10 07:20:22 -0400247# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
248# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800249#ASSUME_PROVIDED += "libsdl2-native"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500250
Brad Bishop79641f22019-09-10 07:20:22 -0400251# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
252# a handy set of menus for controlling the emulator.
Patrick Williams213cb262021-08-07 19:21:33 -0500253#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+"
Brad Bishop79641f22019-09-10 07:20:22 -0400254
Brad Bishop00e122a2019-10-05 11:10:57 -0400255#
256# Hash Equivalence
257#
258# Enable support for automatically running a local hash equivalence server and
259# instruct bitbake to use a hash equivalence aware signature generator. Hash
260# equivalence improves reuse of sstate by detecting when a given sstate
261# artifact can be reused as equivalent, even if the current task hash doesn't
262# match the one that generated the artifact.
263#
264# A shared hash equivalent server can be set with "<HOSTNAME>:<PORT>" format
265#
266#BB_HASHSERVE = "auto"
267#BB_SIGNATURE_HANDLER = "OEEquivHash"
268
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500269#
270# Memory Resident Bitbake
271#
272# Bitbake's server component can stay in memory after the UI for the current command
273# has completed. This means subsequent commands can run faster since there is no need
274# for bitbake to reload cache files and so on. Number is in seconds, after which the
275# server will shut down.
276#
277#BB_SERVER_TIMEOUT = "60"
278
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500279# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
280# track the version of this file when it was generated. This can safely be ignored if
281# this doesn't mean anything to you.
Patrick Williams213cb262021-08-07 19:21:33 -0500282CONF_VERSION = "2"