blob: 4d2fa516fe167ea1662dbd98dfeeb84cf7d290bd [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
8# initially.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05009#
10# Lines starting with the '#' character are commented out and in some cases the
11# default values are provided as comments to show people example syntax. Enabling
12# the option is a question of removing the # character and making any change to the
13# variable as required.
14
15#
16# Machine Selection
17#
18# You need to select a specific machine to target the build with. There are a selection
19# of emulated machines available which can boot and run in the QEMU emulator:
20#
21#MACHINE ?= "qemuarm"
22#MACHINE ?= "qemuarm64"
23#MACHINE ?= "qemumips"
24#MACHINE ?= "qemumips64"
25#MACHINE ?= "qemuppc"
26#MACHINE ?= "qemux86"
27#MACHINE ?= "qemux86-64"
28#
29# There are also the following hardware board target machines included for
30# demonstration purposes:
31#
Brad Bishop316dfdd2018-06-25 12:45:53 -040032#MACHINE ?= "beaglebone-yocto"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050033#MACHINE ?= "genericx86"
34#MACHINE ?= "genericx86-64"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050035#MACHINE ?= "edgerouter"
36#
Brad Bishop15ae2502019-06-18 21:44:24 -040037# This sets the default machine to be qemux86-64 if no other machine is selected:
38MACHINE ??= "qemux86-64"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050039
40#
41# Where to place downloads
42#
43# During a first build the system will download many different source code tarballs
44# from various upstream projects. This can take a while, particularly if your network
45# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
46# can preserve this directory to speed up this part of subsequent builds. This directory
47# is safe to share between multiple builds on the same machine too.
48#
49# The default is a downloads directory under TOPDIR which is the build directory.
50#
51#DL_DIR ?= "${TOPDIR}/downloads"
52
53#
54# Where to place shared-state files
55#
56# BitBake has the capability to accelerate builds based on previously built output.
57# This is done using "shared state" files which can be thought of as cache objects
58# and this option determines where those files are placed.
59#
60# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
61# from these files if no changes were made to the configuration. If changes were made
62# to the configuration, only shared state files where the state was still valid would
63# be used (done using checksums).
64#
65# The default is a sstate-cache directory under TOPDIR.
66#
67#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
68
69#
70# Where to place the build output
71#
72# This option specifies where the bulk of the building work should be done and
73# where BitBake should place its temporary files and output. Keep in mind that
74# this includes the extraction and compilation of many applications and the toolchain
75# which can use Gigabytes of hard disk space.
76#
77# The default is a tmp directory under TOPDIR.
78#
79#TMPDIR = "${TOPDIR}/tmp"
80
81#
82# Default policy config
83#
84# The distribution setting controls which policy settings are used as defaults.
85# The default value is fine for general Yocto project use, at least initially.
86# Ultimately when creating custom policy, people will likely end up subclassing
87# these defaults.
88#
89DISTRO ?= "poky"
90# As an example of a subclass there is a "bleeding" edge policy configuration
91# where many versions are set to the absolute latest code from the upstream
92# source control systems. This is just mentioned here as an example, its not
93# useful to most new users.
94# DISTRO ?= "poky-bleeding"
95
96#
97# Package Management configuration
98#
99# This variable lists which packaging formats to enable. Multiple package backends
100# can be enabled at once and the first item listed in the variable will be used
101# to generate the root filesystems.
102# Options are:
103# - 'package_deb' for debian style deb files
104# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
105# - 'package_rpm' for rpm style packages
106# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
Patrick Williams03907ee2022-05-01 06:28:52 -0500107# OE-Core defaults to ipkg, whilst Poky defaults to rpm:
108# PACKAGE_CLASSES ?= "package_rpm"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500109
110#
111# SDK target architecture
112#
113# This variable specifies the architecture to build SDK items for and means
114# you can build the SDK packages for architectures other than the machine you are
115# running the build on (i.e. building i686 packages on an x86_64 host).
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600116# Supported values are i686, x86_64, aarch64
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500117#SDKMACHINE ?= "i686"
118
119#
120# Extra image configuration defaults
121#
122# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
123# images. Some of these options are added to certain image types automatically. The
124# variable can contain the following options:
125# "dbg-pkgs" - add -dbg packages for all installed packages
126# (adds symbol information for debugging/profiling)
Brad Bishop19323692019-04-05 15:28:33 -0400127# "src-pkgs" - add -src packages for all installed packages
128# (adds source code for debugging)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500129# "dev-pkgs" - add -dev packages for all installed packages
130# (useful if you want to develop against libs in the image)
131# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
132# (useful if you want to run the package test suites)
133# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
134# "tools-debug" - add debugging tools (gdb, strace)
135# "eclipse-debug" - add Eclipse remote debugging support
136# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
137# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
138# "debug-tweaks" - make an image suitable for development
139# e.g. ssh root access has a blank password
140# There are other application targets that can be used here too, see
141# meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details.
142# We default to enabling the debugging tweaks.
143EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
144
145#
146# Additional image features
147#
148# The following is a list of additional classes to use when building images which
149# enable extra features. Some available options which can be included in this variable
150# are:
151# - 'buildstats' collect build statistics
Patrick Williams213cb262021-08-07 19:21:33 -0500152USER_CLASSES ?= "buildstats"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500153
154#
155# Runtime testing of images
156#
157# The build system can test booting virtual machine images under qemu (an emulator)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300158# after any root filesystems are created and run tests against those images. It can also
159# run tests against any SDK that are built. To enable this uncomment these lines.
160# See classes/test{image,sdk}.bbclass for further details.
161#IMAGE_CLASSES += "testimage testsdk"
Andrew Geisslerd159c7f2021-09-02 21:05:58 -0500162#TESTIMAGE_AUTO:qemuall = "1"
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300163
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500164#
165# Interactive shell configuration
166#
167# Under certain circumstances the system may need input from you and to do this it
168# can launch an interactive shell. It needs to do this since the build is
169# multithreaded and needs to be able to handle the case where more than one parallel
170# process may require the user's attention. The default is iterate over the available
171# terminal types to find one that works.
172#
173# Examples of the occasions this may happen are when resolving patches which cannot
174# be applied, to use the devshell or the kernel menuconfig
175#
176# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
177# Note: currently, Konsole support only works for KDE 3.x due to the way
178# newer Konsole versions behave
179#OE_TERMINAL = "auto"
180# By default disable interactive patch resolution (tasks will just fail instead):
181PATCHRESOLVE = "noop"
182
183#
184# Disk Space Monitoring during the build
185#
186# Monitor the disk space during the build. If there is less that 1GB of space or less
187# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
Andrew Geissler7e0e3c02022-02-25 20:34:39 +0000188# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard halt
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500189# of the build. The reason for this is that running completely out of space can corrupt
190# files and damages the build in ways which may not be easily recoverable.
Andrew Geisslerf0343792020-11-18 10:42:21 -0600191# It's necessary to monitor /tmp, if there is no space left the build will fail
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500192# with very exotic errors.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500193BB_DISKMON_DIRS ??= "\
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500194 STOPTASKS,${TMPDIR},1G,100K \
195 STOPTASKS,${DL_DIR},1G,100K \
196 STOPTASKS,${SSTATE_DIR},1G,100K \
197 STOPTASKS,/tmp,100M,100K \
Andrew Geissler7e0e3c02022-02-25 20:34:39 +0000198 HALT,${TMPDIR},100M,1K \
199 HALT,${DL_DIR},100M,1K \
200 HALT,${SSTATE_DIR},100M,1K \
201 HALT,/tmp,10M,1K"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500202
203#
204# Shared-state files from other locations
205#
Andrew Geissler95ac1b82021-03-31 14:34:31 -0500206# As mentioned above, shared state files are prebuilt cache data objects which can be
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500207# used to accelerate build time. This variable can be used to configure the system
208# to search other mirror locations for these objects before it builds the data itself.
209#
Andrew Geissler9aee5002022-03-30 16:27:02 +0000210# This can be a filesystem directory, or a remote url such as https or ftp. These
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500211# would contain the sstate-cache results from previous builds (possibly from other
212# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
213# cache locations to check for the shared objects.
214# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
215# at the end as shown in the examples below. This will be substituted with the
216# correct path within the directory structure.
217#SSTATE_MIRRORS ?= "\
Andrew Geissler9aee5002022-03-30 16:27:02 +0000218#file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500219#file://.* file:///some/local/dir/sstate/PATH"
220
Brad Bishop316dfdd2018-06-25 12:45:53 -0400221#
222# Yocto Project SState Mirror
223#
224# The Yocto Project has prebuilt artefacts available for its releases, you can enable
Andrew Geissler5199d832021-09-24 16:47:35 -0500225# use of these by uncommenting the following lines. This will mean the build uses
Brad Bishop316dfdd2018-06-25 12:45:53 -0400226# the network to check for artefacts at the start of builds, which does slow it down
227# equally, it will also speed up the builds by not having to build things if they are
228# present in the cache. It assumes you can download something faster than you can build it
229# which will depend on your network.
Andrew Geissler5199d832021-09-24 16:47:35 -0500230# Note: For this to work you also need hash-equivalence passthrough to the matching server
Brad Bishop316dfdd2018-06-25 12:45:53 -0400231#
Andrew Geissler5199d832021-09-24 16:47:35 -0500232#BB_HASHSERVE_UPSTREAM = "typhoon.yocto.io:8687"
Patrick Williams03907ee2022-05-01 06:28:52 -0500233#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/4.0/PATH;downloadfilename=PATH"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500234
235#
236# Qemu configuration
237#
Brad Bishop08902b02019-08-20 09:16:51 -0400238# By default native qemu will build with a builtin VNC server where graphical output can be
Brad Bishop79641f22019-09-10 07:20:22 -0400239# seen. The line below enables the SDL UI frontend too.
Patrick Williams213cb262021-08-07 19:21:33 -0500240PACKAGECONFIG:append:pn-qemu-system-native = " sdl"
Brad Bishop79641f22019-09-10 07:20:22 -0400241# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
242# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800243#ASSUME_PROVIDED += "libsdl2-native"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500244
Brad Bishop79641f22019-09-10 07:20:22 -0400245# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
246# a handy set of menus for controlling the emulator.
Patrick Williams213cb262021-08-07 19:21:33 -0500247#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+"
Brad Bishop79641f22019-09-10 07:20:22 -0400248
Brad Bishop00e122a2019-10-05 11:10:57 -0400249#
250# Hash Equivalence
251#
252# Enable support for automatically running a local hash equivalence server and
253# instruct bitbake to use a hash equivalence aware signature generator. Hash
254# equivalence improves reuse of sstate by detecting when a given sstate
255# artifact can be reused as equivalent, even if the current task hash doesn't
256# match the one that generated the artifact.
257#
258# A shared hash equivalent server can be set with "<HOSTNAME>:<PORT>" format
259#
260#BB_HASHSERVE = "auto"
261#BB_SIGNATURE_HANDLER = "OEEquivHash"
262
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500263#
264# Memory Resident Bitbake
265#
266# Bitbake's server component can stay in memory after the UI for the current command
267# has completed. This means subsequent commands can run faster since there is no need
268# for bitbake to reload cache files and so on. Number is in seconds, after which the
269# server will shut down.
270#
271#BB_SERVER_TIMEOUT = "60"
272
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500273# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
274# track the version of this file when it was generated. This can safely be ignored if
275# this doesn't mean anything to you.
Patrick Williams213cb262021-08-07 19:21:33 -0500276CONF_VERSION = "2"