blob: d2f4b861851b691dfb0c5a1fd4edfd64358dd29c [file] [log] [blame]
Brad Bishop0e8aea62015-09-25 14:31:27 -04001#
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
Adriana Kobylak4d93f922021-08-11 15:46:10 +00005# be set in this file. More adventurous users can look at local.conf.extended
Brad Bishop0e8aea62015-09-25 14:31:27 -04006# 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#
Adriana Kobylak4d93f922021-08-11 15:46:10 +00009# Lines starting with the '#' character are commented out and in some cases the
Brad Bishop0e8aea62015-09-25 14:31:27 -040010# 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"
Adriana Kobylak4d93f922021-08-11 15:46:10 +000023#MACHINE ?= "qemumips64"
Brad Bishop0e8aea62015-09-25 14:31:27 -040024#MACHINE ?= "qemuppc"
25#MACHINE ?= "qemux86"
26#MACHINE ?= "qemux86-64"
27#
Adriana Kobylak4d93f922021-08-11 15:46:10 +000028# There are also the following hardware board target machines included for
Brad Bishop0e8aea62015-09-25 14:31:27 -040029# demonstration purposes:
30#
Adriana Kobylak4d93f922021-08-11 15:46:10 +000031#MACHINE ?= "beaglebone-yocto"
Brad Bishop0e8aea62015-09-25 14:31:27 -040032#MACHINE ?= "genericx86"
33#MACHINE ?= "genericx86-64"
Brad Bishop0e8aea62015-09-25 14:31:27 -040034#MACHINE ?= "edgerouter"
35#
36# This sets the default machine to be qemux86 if no other machine is selected:
37MACHINE ??= "palmetto"
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#
53# Where to place shared-state files
54#
55# BitBake has the capability to accelerate builds based on previously built output.
56# This is done using "shared state" files which can be thought of as cache objects
57# and this option determines where those files are placed.
58#
59# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
60# from these files if no changes were made to the configuration. If changes were made
61# to the configuration, only shared state files where the state was still valid would
62# be used (done using checksums).
63#
64# The default is a sstate-cache directory under TOPDIR.
65#
66#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
67
68#
69# Where to place the build output
70#
71# This option specifies where the bulk of the building work should be done and
72# where BitBake should place its temporary files and output. Keep in mind that
73# this includes the extraction and compilation of many applications and the toolchain
74# which can use Gigabytes of hard disk space.
75#
76# The default is a tmp directory under TOPDIR.
77#
78#TMPDIR = "${TOPDIR}/tmp"
79
80#
81# Default policy config
82#
83# The distribution setting controls which policy settings are used as defaults.
84# The default value is fine for general Yocto project use, at least initially.
Adriana Kobylak4d93f922021-08-11 15:46:10 +000085# Ultimately when creating custom policy, people will likely end up subclassing
Brad Bishop0e8aea62015-09-25 14:31:27 -040086# these defaults.
87#
Brad Bishop509842a2018-03-09 01:02:10 -050088DISTRO ?= "openbmc-openpower"
Brad Bishop0e8aea62015-09-25 14:31:27 -040089# As an example of a subclass there is a "bleeding" edge policy configuration
Adriana Kobylak4d93f922021-08-11 15:46:10 +000090# where many versions are set to the absolute latest code from the upstream
Brad Bishop0e8aea62015-09-25 14:31:27 -040091# source control systems. This is just mentioned here as an example, its not
92# useful to most new users.
93# DISTRO ?= "poky-bleeding"
94
95#
96# Package Management configuration
97#
Adriana Kobylak4d93f922021-08-11 15:46:10 +000098# This variable lists which packaging formats to enable. Multiple package backends
99# can be enabled at once and the first item listed in the variable will be used
Brad Bishop0e8aea62015-09-25 14:31:27 -0400100# to generate the root filesystems.
101# Options are:
102# - 'package_deb' for debian style deb files
103# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
104# - 'package_rpm' for rpm style packages
105# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
Patrick Williamsb3b2aee2021-09-16 14:23:05 -0500106# We default to ipk:
Andrew Jeffery605c37c2021-09-15 09:12:36 +0930107PACKAGE_CLASSES ?= "package_ipk"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400108
109#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000110# SDK target architecture
Brad Bishop0e8aea62015-09-25 14:31:27 -0400111#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000112# This variable specifies the architecture to build SDK items for and means
113# you can build the SDK packages for architectures other than the machine you are
Brad Bishop0e8aea62015-09-25 14:31:27 -0400114# running the build on (i.e. building i686 packages on an x86_64 host).
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000115# Supported values are i686, x86_64, aarch64
Brad Bishop0e8aea62015-09-25 14:31:27 -0400116#SDKMACHINE ?= "i686"
117
Adriana Kobylakb96c7502021-08-06 16:25:30 +0000118SANITY_TESTED_DISTROS:append ?= " RedHatEnterpriseWorkstation-6.*"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400119
120#
121# Extra image configuration defaults
122#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000123# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
Brad Bishop0e8aea62015-09-25 14:31:27 -0400124# images. Some of these options are added to certain image types automatically. The
125# variable can contain the following options:
126# "dbg-pkgs" - add -dbg packages for all installed packages
127# (adds symbol information for debugging/profiling)
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000128# "src-pkgs" - add -src packages for all installed packages
129# (adds source code for debugging)
Brad Bishop0e8aea62015-09-25 14:31:27 -0400130# "dev-pkgs" - add -dev packages for all installed packages
131# (useful if you want to develop against libs in the image)
132# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
133# (useful if you want to run the package test suites)
134# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
135# "tools-debug" - add debugging tools (gdb, strace)
136# "eclipse-debug" - add Eclipse remote debugging support
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000137# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
Brad Bishop0e8aea62015-09-25 14:31:27 -0400138# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
139# "debug-tweaks" - make an image suitable for development
140# e.g. ssh root access has a blank password
141# There are other application targets that can be used here too, see
142# meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details.
143# We default to enabling the debugging tweaks.
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000144EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400145
146#
147# Additional image features
148#
149# The following is a list of additional classes to use when building images which
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000150# enable extra features. Some available options which can be included in this variable
Brad Bishop0e8aea62015-09-25 14:31:27 -0400151# are:
152# - 'buildstats' collect build statistics
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000153USER_CLASSES ?= "buildstats"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400154
155#
156# Runtime testing of images
157#
158# The build system can test booting virtual machine images under qemu (an emulator)
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000159# after any root filesystems are created and run tests against those images. It can also
160# run tests against any SDK that are built. To enable this uncomment these lines.
161# See classes/test{image,sdk}.bbclass for further details.
162#IMAGE_CLASSES += "testimage testsdk"
163#TESTIMAGE_AUTO_qemuall = "1"
164
Brad Bishop0e8aea62015-09-25 14:31:27 -0400165#
166# Interactive shell configuration
167#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000168# Under certain circumstances the system may need input from you and to do this it
169# can launch an interactive shell. It needs to do this since the build is
Brad Bishop0e8aea62015-09-25 14:31:27 -0400170# multithreaded and needs to be able to handle the case where more than one parallel
171# process may require the user's attention. The default is iterate over the available
172# terminal types to find one that works.
173#
174# Examples of the occasions this may happen are when resolving patches which cannot
175# be applied, to use the devshell or the kernel menuconfig
176#
177# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
178# Note: currently, Konsole support only works for KDE 3.x due to the way
179# newer Konsole versions behave
180#OE_TERMINAL = "auto"
181# By default disable interactive patch resolution (tasks will just fail instead):
182PATCHRESOLVE = "noop"
183
184#
185# Disk Space Monitoring during the build
186#
187# Monitor the disk space during the build. If there is less that 1GB of space or less
188# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000189# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard abort
Brad Bishop0e8aea62015-09-25 14:31:27 -0400190# of the build. The reason for this is that running completely out of space can corrupt
191# files and damages the build in ways which may not be easily recoverable.
Gunnar Millsca6a7082017-10-25 21:03:00 -0500192# It's necessary to monitor /tmp, if there is no space left the build will fail
Brad Bishop0e8aea62015-09-25 14:31:27 -0400193# with very exotic errors.
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000194BB_DISKMON_DIRS ??= "\
Brad Bishop0e8aea62015-09-25 14:31:27 -0400195 STOPTASKS,${TMPDIR},1G,100K \
196 STOPTASKS,${DL_DIR},1G,100K \
197 STOPTASKS,${SSTATE_DIR},1G,100K \
198 STOPTASKS,/tmp,100M,100K \
199 ABORT,${TMPDIR},100M,1K \
200 ABORT,${DL_DIR},100M,1K \
201 ABORT,${SSTATE_DIR},100M,1K \
202 ABORT,/tmp,10M,1K"
203
204#
205# Shared-state files from other locations
206#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000207# As mentioned above, shared state files are prebuilt cache data objects which can be
Brad Bishop0e8aea62015-09-25 14:31:27 -0400208# used to accelerate build time. This variable can be used to configure the system
209# to search other mirror locations for these objects before it builds the data itself.
210#
211# This can be a filesystem directory, or a remote url such as http or ftp. These
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000212# would contain the sstate-cache results from previous builds (possibly from other
213# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
Brad Bishop0e8aea62015-09-25 14:31:27 -0400214# cache locations to check for the shared objects.
215# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
216# at the end as shown in the examples below. This will be substituted with the
217# correct path within the directory structure.
218#SSTATE_MIRRORS ?= "\
219#file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
220#file://.* file:///some/local/dir/sstate/PATH"
221
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000222#
223# Yocto Project SState Mirror
224#
225# The Yocto Project has prebuilt artefacts available for its releases, you can enable
226# use of these by uncommenting the following line. This will mean the build uses
227# the network to check for artefacts at the start of builds, which does slow it down
228# equally, it will also speed up the builds by not having to build things if they are
229# present in the cache. It assumes you can download something faster than you can build it
230# which will depend on your network.
231#
232#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/2.5/PATH;downloadfilename=PATH"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400233
234#
235# Qemu configuration
236#
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000237# By default native qemu will build with a builtin VNC server where graphical output can be
238# seen. The line below enables the SDL UI frontend too.
239#PACKAGECONFIG:append:pn-qemu-system-native = " sdl"
Adriana Kobylakb96c7502021-08-06 16:25:30 +0000240PACKAGECONFIG:append:pn-qemu-native = " sdl"
241PACKAGECONFIG:append:pn-nativesdk-qemu = " sdl"
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000242# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
243# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
244#ASSUME_PROVIDED += "libsdl2-native"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400245
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000246# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
247# a handy set of menus for controlling the emulator.
248#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+"
249
250#
251# Hash Equivalence
252#
253# Enable support for automatically running a local hash equivalence server and
254# instruct bitbake to use a hash equivalence aware signature generator. Hash
255# equivalence improves reuse of sstate by detecting when a given sstate
256# artifact can be reused as equivalent, even if the current task hash doesn't
257# match the one that generated the artifact.
258#
259# A shared hash equivalent server can be set with "<HOSTNAME>:<PORT>" format
260#
261#BB_HASHSERVE = "auto"
262#BB_SIGNATURE_HANDLER = "OEEquivHash"
263
264#
265# Memory Resident Bitbake
266#
267# Bitbake's server component can stay in memory after the UI for the current command
268# has completed. This means subsequent commands can run faster since there is no need
269# for bitbake to reload cache files and so on. Number is in seconds, after which the
270# server will shut down.
271#
272#BB_SERVER_TIMEOUT = "60"
Brad Bishop0e8aea62015-09-25 14:31:27 -0400273
274# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
275# track the version of this file when it was generated. This can safely be ignored if
276# this doesn't mean anything to you.
Adriana Kobylak4d93f922021-08-11 15:46:10 +0000277CONF_VERSION = "2"