blob: 94e16123851bef33aa20730696cae70ac3d261df [file] [log] [blame]
James Feiste27e5fc2017-11-09 14:31:00 -08001#
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#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070017MACHINE ??= "s2600wf"
James Feiste27e5fc2017-11-09 14:31:00 -080018
19#
20# Where to place downloads
21#
22# During a first build the system will download many different source code tarballs
23# from various upstream projects. This can take a while, particularly if your network
24# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
25# can preserve this directory to speed up this part of subsequent builds. This directory
26# is safe to share between multiple builds on the same machine too.
27#
28# The default is a downloads directory under TOPDIR which is the build directory.
29#
30#DL_DIR ?= "${TOPDIR}/downloads"
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070031
James Feiste27e5fc2017-11-09 14:31:00 -080032#
33# Where to place shared-state files
34#
35# BitBake has the capability to accelerate builds based on previously built output.
36# This is done using "shared state" files which can be thought of as cache objects
37# and this option determines where those files are placed.
38#
39# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
40# from these files if no changes were made to the configuration. If changes were made
41# to the configuration, only shared state files where the state was still valid would
42# be used (done using checksums).
43#
44# The default is a sstate-cache directory under TOPDIR.
45#
46#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
47
48#
49# Where to place the build output
50#
51# This option specifies where the bulk of the building work should be done and
52# where BitBake should place its temporary files and output. Keep in mind that
53# this includes the extraction and compilation of many applications and the toolchain
54# which can use Gigabytes of hard disk space.
55#
56# The default is a tmp directory under TOPDIR.
57#
58#TMPDIR = "${TOPDIR}/tmp"
59
60#
61# Default policy config
62#
63# The distribution setting controls which policy settings are used as defaults.
64# The default value is fine for general Yocto project use, at least initially.
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070065# Ultimately when creating custom policy, people will likely end up subclassing
James Feiste27e5fc2017-11-09 14:31:00 -080066# these defaults.
67#
68DISTRO ?= "openbmc-phosphor"
69# As an example of a subclass there is a "bleeding" edge policy configuration
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070070# where many versions are set to the absolute latest code from the upstream
James Feiste27e5fc2017-11-09 14:31:00 -080071# source control systems. This is just mentioned here as an example, its not
72# useful to most new users.
73# DISTRO ?= "poky-bleeding"
74
75#
76# Package Management configuration
77#
78# This variable lists which packaging formats to enable. Multiple package backends
79# can be enabled at once and the first item listed in the variable will be used
80# to generate the root filesystems.
81# Options are:
82# - 'package_deb' for debian style deb files
83# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
84# - 'package_rpm' for rpm style packages
85# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
Patrick Williamsb3b2aee2021-09-16 14:23:05 -050086# We default to ipk:
Andrew Jeffery605c37c2021-09-15 09:12:36 +093087PACKAGE_CLASSES ?= "package_ipk"
James Feiste27e5fc2017-11-09 14:31:00 -080088
89#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070090# SDK target architecture
James Feiste27e5fc2017-11-09 14:31:00 -080091#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070092# This variable specifies the architecture to build SDK items for and means
James Feiste27e5fc2017-11-09 14:31:00 -080093# you can build the SDK packages for architectures other than the machine you are
94# running the build on (i.e. building i686 packages on an x86_64 host).
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -070095# Supported values are i686, x86_64, aarch64
James Feiste27e5fc2017-11-09 14:31:00 -080096#SDKMACHINE ?= "i686"
James Feiste27e5fc2017-11-09 14:31:00 -080097
98#
99# Extra image configuration defaults
100#
101# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
102# images. Some of these options are added to certain image types automatically. The
103# variable can contain the following options:
104# "dbg-pkgs" - add -dbg packages for all installed packages
105# (adds symbol information for debugging/profiling)
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700106# "src-pkgs" - add -src packages for all installed packages
107# (adds source code for debugging)
James Feiste27e5fc2017-11-09 14:31:00 -0800108# "dev-pkgs" - add -dev packages for all installed packages
109# (useful if you want to develop against libs in the image)
110# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
111# (useful if you want to run the package test suites)
112# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
113# "tools-debug" - add debugging tools (gdb, strace)
114# "eclipse-debug" - add Eclipse remote debugging support
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700115# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
James Feiste27e5fc2017-11-09 14:31:00 -0800116# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
117# "debug-tweaks" - make an image suitable for development
118# e.g. ssh root access has a blank password
119# There are other application targets that can be used here too, see
120# meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details.
121# We default to enabling the debugging tweaks.
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700122EXTRA_IMAGE_FEATURES ?= "debug-tweaks"
James Feiste27e5fc2017-11-09 14:31:00 -0800123
124#
125# Additional image features
126#
127# The following is a list of additional classes to use when building images which
128# enable extra features. Some available options which can be included in this variable
129# are:
130# - 'buildstats' collect build statistics
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700131USER_CLASSES ?= "buildstats"
James Feiste27e5fc2017-11-09 14:31:00 -0800132
133#
134# Runtime testing of images
135#
136# The build system can test booting virtual machine images under qemu (an emulator)
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700137# after any root filesystems are created and run tests against those images. It can also
138# run tests against any SDK that are built. To enable this uncomment these lines.
139# See classes/test{image,sdk}.bbclass for further details.
140#IMAGE_CLASSES += "testimage testsdk"
141#TESTIMAGE_AUTO_qemuall = "1"
142
James Feiste27e5fc2017-11-09 14:31:00 -0800143#
144# Interactive shell configuration
145#
146# Under certain circumstances the system may need input from you and to do this it
147# can launch an interactive shell. It needs to do this since the build is
148# multithreaded and needs to be able to handle the case where more than one parallel
149# process may require the user's attention. The default is iterate over the available
150# terminal types to find one that works.
151#
152# Examples of the occasions this may happen are when resolving patches which cannot
153# be applied, to use the devshell or the kernel menuconfig
154#
155# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
156# Note: currently, Konsole support only works for KDE 3.x due to the way
157# newer Konsole versions behave
158#OE_TERMINAL = "auto"
159# By default disable interactive patch resolution (tasks will just fail instead):
160PATCHRESOLVE = "noop"
161
162#
163# Disk Space Monitoring during the build
164#
165# Monitor the disk space during the build. If there is less that 1GB of space or less
166# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700167# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard abort
James Feiste27e5fc2017-11-09 14:31:00 -0800168# of the build. The reason for this is that running completely out of space can corrupt
169# files and damages the build in ways which may not be easily recoverable.
170# It's necessary to monitor /tmp, if there is no space left the build will fail
171# with very exotic errors.
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700172BB_DISKMON_DIRS ??= "\
James Feiste27e5fc2017-11-09 14:31:00 -0800173 STOPTASKS,${TMPDIR},1G,100K \
174 STOPTASKS,${DL_DIR},1G,100K \
175 STOPTASKS,${SSTATE_DIR},1G,100K \
176 STOPTASKS,/tmp,100M,100K \
177 ABORT,${TMPDIR},100M,1K \
178 ABORT,${DL_DIR},100M,1K \
179 ABORT,${SSTATE_DIR},100M,1K \
180 ABORT,/tmp,10M,1K"
181
182#
183# Shared-state files from other locations
184#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700185# As mentioned above, shared state files are prebuilt cache data objects which can be
James Feiste27e5fc2017-11-09 14:31:00 -0800186# used to accelerate build time. This variable can be used to configure the system
187# to search other mirror locations for these objects before it builds the data itself.
188#
189# This can be a filesystem directory, or a remote url such as http or ftp. These
190# would contain the sstate-cache results from previous builds (possibly from other
191# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
192# cache locations to check for the shared objects.
193# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
194# at the end as shown in the examples below. This will be substituted with the
195# correct path within the directory structure.
196#SSTATE_MIRRORS ?= "\
197#file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
198#file://.* file:///some/local/dir/sstate/PATH"
199
200#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700201# Yocto Project SState Mirror
202#
203# The Yocto Project has prebuilt artefacts available for its releases, you can enable
204# use of these by uncommenting the following line. This will mean the build uses
205# the network to check for artefacts at the start of builds, which does slow it down
206# equally, it will also speed up the builds by not having to build things if they are
207# present in the cache. It assumes you can download something faster than you can build it
208# which will depend on your network.
209#
210#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/2.5/PATH;downloadfilename=PATH"
211
212#
James Feiste27e5fc2017-11-09 14:31:00 -0800213# Qemu configuration
214#
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700215# By default native qemu will build with a builtin VNC server where graphical output can be
216# seen. The line below enables the SDL UI frontend too.
217PACKAGECONFIG:append:pn-qemu-system-native = " sdl"
218# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
219# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
220#ASSUME_PROVIDED += "libsdl2-native"
221
222# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
223# a handy set of menus for controlling the emulator.
224#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+"
225
226#
227# Hash Equivalence
228#
229# Enable support for automatically running a local hash equivalence server and
230# instruct bitbake to use a hash equivalence aware signature generator. Hash
231# equivalence improves reuse of sstate by detecting when a given sstate
232# artifact can be reused as equivalent, even if the current task hash doesn't
233# match the one that generated the artifact.
234#
235# A shared hash equivalent server can be set with "<HOSTNAME>:<PORT>" format
236#
237#BB_HASHSERVE = "auto"
238#BB_SIGNATURE_HANDLER = "OEEquivHash"
239
240#
241# Memory Resident Bitbake
242#
243# Bitbake's server component can stay in memory after the UI for the current command
244# has completed. This means subsequent commands can run faster since there is no need
245# for bitbake to reload cache files and so on. Number is in seconds, after which the
246# server will shut down.
247#
248#BB_SERVER_TIMEOUT = "60"
James Feiste27e5fc2017-11-09 14:31:00 -0800249
250# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
251# track the version of this file when it was generated. This can safely be ignored if
252# this doesn't mean anything to you.
Jae Hyun Yoo24e16a22021-08-06 10:55:59 -0700253CONF_VERSION = "2"