blob: 8b34dad1b1ede0b52aff2b702e41e1beff1e774d [file] [log] [blame]
Grant O'Connor4ef8b202023-08-28 08:51:19 -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# Machine Selection
15#
16# You need to select a specific machine to target the build with. There are a selection
17# of emulated machines available which can boot and run in the QEMU emulator:
18#
19#MACHINE ?= "qemuarm"
20#MACHINE ?= "qemuarm64"
21#MACHINE ?= "qemumips"
22#MACHINE ?= "qemumips64"
23#MACHINE ?= "qemuppc"
24#MACHINE ?= "qemux86"
25#MACHINE ?= "qemux86-64"
26#
27# There are also the following hardware board target machines included for
28# demonstration purposes:
29#
30#MACHINE ?= "beaglebone-yocto"
31#MACHINE ?= "genericx86"
32#MACHINE ?= "genericx86-64"
33#MACHINE ?= "mpc8315e-rdb"
34#MACHINE ?= "edgerouter"
35#
36# This sets the default machine to be qemux86-64 if no other machine is selected:
37MACHINE ??= "dl385-g11"
38
39#
40# Where to place downloads
41#
42# During a first build the system will download many different source code tarballs
43# from various upstream projects. This can take a while, particularly if your network
44# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
45# can preserve this directory to speed up this part of subsequent builds. This directory
46# is safe to share between multiple builds on the same machine too.
47#
48# The default is a downloads directory under TOPDIR which is the build directory.
49#
50#DL_DIR ?= "${TOPDIR}/downloads"
51#
52# Where to place shared-state files
53#
54# BitBake has the capability to accelerate builds based on previously built output.
55# This is done using "shared state" files which can be thought of as cache objects
56# and this option determines where those files are placed.
57#
58# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
59# from these files if no changes were made to the configuration. If changes were made
60# to the configuration, only shared state files where the state was still valid would
61# be used (done using checksums).
62#
63# The default is a sstate-cache directory under TOPDIR.
64#
65#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
66#
67# Where to place the build output
68#
69# This option specifies where the bulk of the building work should be done and
70# where BitBake should place its temporary files and output. Keep in mind that
71# this includes the extraction and compilation of many applications and the toolchain
72# which can use Gigabytes of hard disk space.
73#
74# The default is a tmp directory under TOPDIR.
75#
76#TMPDIR = "${TOPDIR}/tmp"
77#
78# Default policy config
79#
80# The distribution setting controls which policy settings are used as defaults.
81# The default value is fine for general Yocto project use, at least initially.
82# Ultimately when creating custom policy, people will likely end up subclassing
83# these defaults.
84#
85DISTRO ?= "poky"
86
87# As an example of a subclass there is a "bleeding" edge policy configuration
88# where many versions are set to the absolute latest code from the upstream
89# source control systems. This is just mentioned here as an example, its not
90# useful to most new users.
91# DISTRO ?= "poky-bleeding"
92#
93# Package Management configuration
94#
95# This variable lists which packaging formats to enable. Multiple package backends
96# can be enabled at once and the first item listed in the variable will be used
97# to generate the root filesystems.
98# Options are:
99# - 'package_deb' for debian style deb files
100# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
101# - 'package_rpm' for rpm style packages
102# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
103# We default to rpm:
104PACKAGE_CLASSES ?= "package_rpm"
105
106#
107# SDK target architecture
108#
109# This variable specifies the architecture to build SDK items for and means
110# you can build the SDK packages for architectures other than the machine you are
111# running the build on (i.e. building i686 packages on an x86_64 host).
112# Supported values are i686 and x86_64
113#SDKMACHINE ?= "i686"
114#
115# Extra image configuration defaults
116#
117# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
118# images. Some of these options are added to certain image types automatically. The
119# variable can contain the following options:
120# "dbg-pkgs" - add -dbg packages for all installed packages
121# (adds symbol information for debugging/profiling)
122# "src-pkgs" - add -src packages for all installed packages
123# (adds source code for debugging)
124# "dev-pkgs" - add -dev packages for all installed packages
125# (useful if you want to develop against libs in the image)
126# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
127# (useful if you want to run the package test suites)
128# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
129# "tools-debug" - add debugging tools (gdb, strace)
130# "eclipse-debug" - add Eclipse remote debugging support
131# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
132# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
133# "debug-tweaks" - make an image suitable for development
134# e.g. ssh root access has a blank password
135# There are other application targets that can be used here too, see
136# meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details.
137# We default to enabling the debugging tweaks.
138EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
139
140#
141# Additional image features
142#
143# The following is a list of additional classes to use when building images which
144# enable extra features. Some available options which can be included in this variable
145# are:
146# - 'buildstats' collect build statistics
147# - 'image-mklibs' to reduce shared library files size for an image
148# - 'image-prelink' in order to prelink the filesystem image
149# NOTE: if listing mklibs & prelink both, then make sure mklibs is before prelink
150# NOTE: mklibs also needs to be explicitly enabled for a given image, see local.conf.extended
151USER_CLASSES ?= "buildstats"
152
153#
154# Runtime testing of images
155#
156# The build system can test booting virtual machine images under qemu (an emulator)
157# after any root filesystems are created and run tests against those images. It can also
158# run tests against any SDK that are built. To enable this uncomment these lines.
159# See classes/test{image,sdk}.bbclass for further details.
160#IMAGE_CLASSES += "testimage testsdk"
161#TESTIMAGE_AUTO_qemuall = "1"
162
163#
164# Interactive shell configuration
165#
166# Under certain circumstances the system may need input from you and to do this it
167# can launch an interactive shell. It needs to do this since the build is
168# multithreaded and needs to be able to handle the case where more than one parallel
169# process may require the user's attention. The default is iterate over the available
170# terminal types to find one that works.
171#
172# Examples of the occasions this may happen are when resolving patches which cannot
173# be applied, to use the devshell or the kernel menuconfig
174#
175# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
176# Note: currently, Konsole support only works for KDE 3.x due to the way
177# newer Konsole versions behave
178#OE_TERMINAL = "auto"
179# By default disable interactive patch resolution (tasks will just fail instead):
180PATCHRESOLVE = "noop"
181
182#
183# Disk Space Monitoring during the build
184#
185# Monitor the disk space during the build. If there is less that 1GB of space or less
186# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
187# shutdown the build. If there is less that 100MB or 1K inodes, perform a hard abort
188# of the build. The reason for this is that running completely out of space can corrupt
189# files and damages the build in ways which may not be easily recoverable.
190# It's necesary to monitor /tmp, if there is no space left the build will fail
191# with very exotic errors.
192BB_DISKMON_DIRS ??= "\
193 STOPTASKS,${TMPDIR},1G,100K \
194 STOPTASKS,${DL_DIR},1G,100K \
195 STOPTASKS,${SSTATE_DIR},1G,100K \
196 STOPTASKS,/tmp,100M,100K \
197 ABORT,${TMPDIR},100M,1K \
198 ABORT,${DL_DIR},100M,1K \
199 ABORT,${SSTATE_DIR},100M,1K \
200 ABORT,/tmp,10M,1K"
201
202#
203# Shared-state files from other locations
204#
205# As mentioned above, shared state files are prebuilt cache data objects which can
206# used to accelerate build time. This variable can be used to configure the system
207# to search other mirror locations for these objects before it builds the data itself.
208#
209# This can be a filesystem directory, or a remote url such as http or ftp. These
210# would contain the sstate-cache results from previous builds (possibly from other
211# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
212# cache locations to check for the shared objects.
213# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
214# at the end as shown in the examples below. This will be substituted with the
215# correct path within the directory structure.
216#SSTATE_MIRRORS ?= "\
217#file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
218#file://.* file:///some/local/dir/sstate/PATH"
219#
220# Yocto Project SState Mirror
221#
222# The Yocto Project has prebuilt artefacts available for its releases, you can enable
223# use of these by uncommenting the following line. This will mean the build uses
224# the network to check for artefacts at the start of builds, which does slow it down
225# equally, it will also speed up the builds by not having to build things if they are
226# present in the cache. It assumes you can download something faster than you can build it
227# which will depend on your network.
228#
229#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/2.5/PATH;downloadfilename=PATH"
230#
231# Qemu configuration
232#
233# By default native qemu will build with a builtin VNC server where graphical output can be
234# seen. The line below enables the SDL UI frontend too.
235PACKAGECONFIG_append_pn-qemu-system-native = " sdl"
236# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
237# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
238#ASSUME_PROVIDED += "libsdl2-native"
239# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
240# a handy set of menus for controlling the emulator.
241#PACKAGECONFIG_append_pn-qemu-system-native = " gtk+"
242# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
243# track the version of this file when it was generated. This can safely be ignored if
244# this doesn't mean anything to you.
245CONF_VERSION = "1"