blob: 59b4d9561d5a0e064030a3cf7da6b413aaa582f9 [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
5# be set in this file. More adventurous users can look at local.conf.extended
6# which contains other examples of configuration which can be placed in this file
7# but new users likely won't need any of them initially.
8#
9# Lines starting with the '#' character are commented out and in some cases the
10# default values are provided as comments to show people example syntax. Enabling
11# the option is a question of removing the # character and making any change to the
12# variable as required.
13
14#
15# Machine Selection
16#
17# You need to select a specific machine to target the build with. There are a selection
18# of emulated machines available which can boot and run in the QEMU emulator:
19#
20#MACHINE ?= "qemuarm"
21#MACHINE ?= "qemuarm64"
22#MACHINE ?= "qemumips"
23#MACHINE ?= "qemumips64"
24#MACHINE ?= "qemuppc"
25#MACHINE ?= "qemux86"
26#MACHINE ?= "qemux86-64"
27#
28# There are also the following hardware board target machines included for
29# demonstration purposes:
30#
Brad Bishop316dfdd2018-06-25 12:45:53 -040031#MACHINE ?= "beaglebone-yocto"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050032#MACHINE ?= "genericx86"
33#MACHINE ?= "genericx86-64"
34#MACHINE ?= "mpc8315e-rdb"
35#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"
107# We default to rpm:
108PACKAGE_CLASSES ?= "package_rpm"
109
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).
116# Supported values are i686 and x86_64
117#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
152# - 'image-mklibs' to reduce shared library files size for an image
153# - 'image-prelink' in order to prelink the filesystem image
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500154# NOTE: if listing mklibs & prelink both, then make sure mklibs is before prelink
155# NOTE: mklibs also needs to be explicitly enabled for a given image, see local.conf.extended
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600156USER_CLASSES ?= "buildstats image-mklibs image-prelink"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500157
158#
159# Runtime testing of images
160#
161# The build system can test booting virtual machine images under qemu (an emulator)
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300162# after any root filesystems are created and run tests against those images. It can also
163# run tests against any SDK that are built. To enable this uncomment these lines.
164# See classes/test{image,sdk}.bbclass for further details.
165#IMAGE_CLASSES += "testimage testsdk"
166#TESTIMAGE_AUTO_qemuall = "1"
167
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500168#
169# Interactive shell configuration
170#
171# Under certain circumstances the system may need input from you and to do this it
172# can launch an interactive shell. It needs to do this since the build is
173# multithreaded and needs to be able to handle the case where more than one parallel
174# process may require the user's attention. The default is iterate over the available
175# terminal types to find one that works.
176#
177# Examples of the occasions this may happen are when resolving patches which cannot
178# be applied, to use the devshell or the kernel menuconfig
179#
180# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
181# Note: currently, Konsole support only works for KDE 3.x due to the way
182# newer Konsole versions behave
183#OE_TERMINAL = "auto"
184# By default disable interactive patch resolution (tasks will just fail instead):
185PATCHRESOLVE = "noop"
186
187#
188# Disk Space Monitoring during the build
189#
190# Monitor the disk space during the build. If there is less that 1GB of space or less
191# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
192# shutdown the build. If there is less that 100MB or 1K inodes, perform a hard abort
193# of the build. The reason for this is that running completely out of space can corrupt
194# files and damages the build in ways which may not be easily recoverable.
195# It's necesary to monitor /tmp, if there is no space left the build will fail
196# with very exotic errors.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500197BB_DISKMON_DIRS ??= "\
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500198 STOPTASKS,${TMPDIR},1G,100K \
199 STOPTASKS,${DL_DIR},1G,100K \
200 STOPTASKS,${SSTATE_DIR},1G,100K \
201 STOPTASKS,/tmp,100M,100K \
202 ABORT,${TMPDIR},100M,1K \
203 ABORT,${DL_DIR},100M,1K \
204 ABORT,${SSTATE_DIR},100M,1K \
205 ABORT,/tmp,10M,1K"
206
207#
208# Shared-state files from other locations
209#
210# As mentioned above, shared state files are prebuilt cache data objects which can
211# used to accelerate build time. This variable can be used to configure the system
212# to search other mirror locations for these objects before it builds the data itself.
213#
214# This can be a filesystem directory, or a remote url such as http or ftp. These
215# would contain the sstate-cache results from previous builds (possibly from other
216# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
217# cache locations to check for the shared objects.
218# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
219# at the end as shown in the examples below. This will be substituted with the
220# correct path within the directory structure.
221#SSTATE_MIRRORS ?= "\
222#file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
223#file://.* file:///some/local/dir/sstate/PATH"
224
Brad Bishop316dfdd2018-06-25 12:45:53 -0400225#
226# Yocto Project SState Mirror
227#
228# The Yocto Project has prebuilt artefacts available for its releases, you can enable
229# use of these by uncommenting the following line. This will mean the build uses
230# the network to check for artefacts at the start of builds, which does slow it down
231# equally, it will also speed up the builds by not having to build things if they are
232# present in the cache. It assumes you can download something faster than you can build it
233# which will depend on your network.
234#
235#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/2.5/PATH;downloadfilename=PATH"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500236
237#
238# Qemu configuration
239#
240# By default qemu will build with a builtin VNC server where graphical output can be
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800241# seen. The two lines below enable the SDL backend too. By default libsdl2-native will
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500242# be built, if you want to use your host's libSDL instead of the minimal libsdl built
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800243# by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
Brad Bishop19323692019-04-05 15:28:33 -0400244PACKAGECONFIG_append_pn-qemu-system-native = " sdl"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500245PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800246#ASSUME_PROVIDED += "libsdl2-native"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500247
248# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
249# track the version of this file when it was generated. This can safely be ignored if
250# this doesn't mean anything to you.
251CONF_VERSION = "1"