summaryrefslogtreecommitdiffstats
path: root/meta-poky/conf/templates/default/local.conf.sample
diff options
context:
space:
mode:
Diffstat (limited to 'meta-poky/conf/templates/default/local.conf.sample')
-rw-r--r--meta-poky/conf/templates/default/local.conf.sample283
1 files changed, 283 insertions, 0 deletions
diff --git a/meta-poky/conf/templates/default/local.conf.sample b/meta-poky/conf/templates/default/local.conf.sample
new file mode 100644
index 0000000000..3d830d5b76
--- /dev/null
+++ b/meta-poky/conf/templates/default/local.conf.sample
@@ -0,0 +1,283 @@
1#
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
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. There's also site.conf.sample which contains examples of site specific
9# information such as proxy server addresses.
10#
11# Lines starting with the '#' character are commented out and in some cases the
12# default values are provided as comments to show people example syntax. Enabling
13# the option is a question of removing the # character and making any change to the
14# variable as required.
15
16#
17# Machine Selection
18#
19# You need to select a specific machine to target the build with. There are a selection
20# of emulated machines available which can boot and run in the QEMU emulator:
21#
22#MACHINE ?= "qemuarm"
23#MACHINE ?= "qemuarm64"
24#MACHINE ?= "qemuriscv64"
25#MACHINE ?= "qemux86"
26#MACHINE ?= "qemux86-64"
27#
28# There are also the following hardware board target machines included for
29# demonstration purposes:
30#
31#MACHINE ?= "beaglebone-yocto"
32#MACHINE ?= "genericarm64"
33#MACHINE ?= "genericx86"
34#MACHINE ?= "genericx86-64"
35#
36# This sets the default machine to be qemux86-64 if no other machine is selected:
37MACHINE ??= "qemux86-64"
38
39# These are some of the more commonly used values. Looking at the files in the
40# meta/conf/machine directory, or the conf/machine directory of any additional layers
41# you add in will show all the available machines.
42
43#
44# Where to place downloads
45#
46# During a first build the system will download many different source code tarballs
47# from various upstream projects. This can take a while, particularly if your network
48# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
49# can preserve this directory to speed up this part of subsequent builds. This directory
50# is safe to share between multiple builds on the same machine too.
51#
52# The default is a downloads directory under TOPDIR which is the build directory.
53#
54#DL_DIR ?= "${TOPDIR}/downloads"
55
56#
57# Where to place shared-state files
58#
59# BitBake has the capability to accelerate builds based on previously built output.
60# This is done using "shared state" files which can be thought of as cache objects
61# and this option determines where those files are placed.
62#
63# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
64# from these files if no changes were made to the configuration. If changes were made
65# to the configuration, only shared state files where the state was still valid would
66# be used (done using checksums).
67#
68# The default is a sstate-cache directory under TOPDIR.
69#
70#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
71
72#
73# Where to place the build output
74#
75# This option specifies where the bulk of the building work should be done and
76# where BitBake should place its temporary files and output. Keep in mind that
77# this includes the extraction and compilation of many applications and the toolchain
78# which can use Gigabytes of hard disk space.
79#
80# The default is a tmp directory under TOPDIR.
81#
82#TMPDIR = "${TOPDIR}/tmp"
83
84#
85# Default policy config
86#
87# The distribution setting controls which policy settings are used as defaults.
88# The default value is fine for general Yocto project use, at least initially.
89# Ultimately when creating custom policy, people will likely end up subclassing
90# these defaults.
91#
92DISTRO ?= "poky"
93# As an example of a subclass there is a "bleeding" edge policy configuration
94# where many versions are set to the absolute latest code from the upstream
95# source control systems. This is just mentioned here as an example, its not
96# useful to most new users.
97# DISTRO ?= "poky-bleeding"
98
99#
100# Package Management configuration
101#
102# This variable lists which packaging formats to enable. Multiple package backends
103# can be enabled at once and the first item listed in the variable will be used
104# to generate the root filesystems.
105# Options are:
106# - 'package_deb' for debian style deb files
107# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
108# - 'package_rpm' for rpm style packages
109# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
110# OE-Core defaults to ipkg, whilst Poky defaults to rpm:
111# PACKAGE_CLASSES ?= "package_rpm"
112
113#
114# SDK target architecture
115#
116# This variable specifies the architecture to build SDK items for and means
117# you can build the SDK packages for architectures other than the machine you are
118# running the build on (i.e. building i686 packages on an x86_64 host).
119# Supported values are i686, x86_64, aarch64
120#SDKMACHINE ?= "i686"
121
122#
123# Extra image configuration defaults
124#
125# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated
126# images. Some of these options are added to certain image types automatically. Some
127# of the features available are:
128# "dbg-pkgs" - add -dbg packages for all installed packages
129# (adds symbol information for debugging/profiling)
130# "src-pkgs" - add -src packages for all installed packages
131# (adds source code for debugging)
132# "dev-pkgs" - add -dev packages for all installed packages
133# (useful if you want to develop against libs in the image)
134# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages
135# (useful if you want to run the package test suites)
136# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.)
137# "tools-debug" - add debugging tools (gdb, strace)
138# "eclipse-debug" - add Eclipse remote debugging support
139# "tools-profile" - add profiling tools (oprofile, lttng, valgrind)
140# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
141# "allow-empty-password" - allow users to have an empty password
142# "empty-root-password" - the root user has no password set
143# "allow-root-login - the root user can login
144# There are other features that can be used here too, see
145# meta/classes-recipe/image.bbclass and
146# meta/classes-recipe/core-image.bbclass for more details.
147# We default to allowing root login without a password for convenience.
148EXTRA_IMAGE_FEATURES ?= "allow-empty-password empty-root-password allow-root-login"
149
150#
151# Additional image features
152#
153# The following is a list of additional classes to use when building images which
154# enable extra features. Some available options which can be included in this variable
155# are:
156# - 'buildstats' collect build statistics
157USER_CLASSES ?= "buildstats"
158
159#
160# Runtime testing of images
161#
162# The build system can test booting virtual machine images under qemu (an emulator)
163# after any root filesystems are created and run tests against those images. It can also
164# run tests against any SDK that are built. To enable this uncomment these lines.
165# See meta/classes-recipe/test{image,sdk}.bbclass for further details.
166#IMAGE_CLASSES += "testimage testsdk"
167#TESTIMAGE_AUTO:qemuall = "1"
168
169#
170# Interactive shell configuration
171#
172# Under certain circumstances the system may need input from you and to do this it
173# can launch an interactive shell. It needs to do this since the build is
174# multithreaded and needs to be able to handle the case where more than one parallel
175# process may require the user's attention. The default is iterate over the available
176# terminal types to find one that works.
177#
178# Examples of the occasions this may happen are when resolving patches which cannot
179# be applied, to use the devshell or the kernel menuconfig
180#
181# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
182# Note: currently, Konsole support only works for KDE 3.x due to the way
183# newer Konsole versions behave
184#OE_TERMINAL = "auto"
185# By default disable interactive patch resolution (tasks will just fail instead):
186PATCHRESOLVE = "noop"
187
188#
189# Disk Space Monitoring during the build
190#
191# Monitor the disk space during the build. If there is less that 1GB of space or less
192# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
193# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard halt
194# of the build. The reason for this is that running completely out of space can corrupt
195# files and damages the build in ways which may not be easily recoverable.
196# It's necessary to monitor /tmp, if there is no space left the build will fail
197# with very exotic errors.
198BB_DISKMON_DIRS ??= "\
199 STOPTASKS,${TMPDIR},1G,100K \
200 STOPTASKS,${DL_DIR},1G,100K \
201 STOPTASKS,${SSTATE_DIR},1G,100K \
202 STOPTASKS,/tmp,100M,100K \
203 HALT,${TMPDIR},100M,1K \
204 HALT,${DL_DIR},100M,1K \
205 HALT,${SSTATE_DIR},100M,1K \
206 HALT,/tmp,10M,1K"
207
208#
209# Shared-state files from other locations
210#
211# As mentioned above, shared state files are prebuilt cache data objects which can be
212# used to accelerate build time. This variable can be used to configure the system
213# to search other mirror locations for these objects before it builds the data itself.
214#
215# This can be a filesystem directory, or a remote url such as https or ftp. These
216# would contain the sstate-cache results from previous builds (possibly from other
217# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the
218# cache locations to check for the shared objects.
219# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
220# at the end as shown in the examples below. This will be substituted with the
221# correct path within the directory structure.
222#SSTATE_MIRRORS ?= "\
223#file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \
224#file://.* file:///some/local/dir/sstate/PATH"
225
226#
227# Yocto Project SState Mirror
228#
229# The Yocto Project has prebuilt artefacts available for its releases, you can enable
230# use of these by uncommenting some of the following lines. This will mean the build uses
231# the network to check for artefacts at the start of builds, which does slow it down
232# initially but it will then speed up the builds by not having to build things if they are
233# present in the cache. It assumes you can download something faster than you can build it
234# which will depend on your network.
235# Note: For this to work you also need hash-equivalence passthrough to the matching server
236# There is a choice between our sstate server directly and a faster content delivery network
237# (CDN) kindly provided by JSDelivr, uncomment one of the SSTATE_MIRRORS lines, not both.
238# Using the CDN rather than the yoctoproject.org address is suggested/preferred.
239#
240#BB_HASHSERVE_UPSTREAM = 'wss://hashserv.yoctoproject.org/ws'
241#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH"
242
243#
244# Qemu configuration
245#
246# By default native qemu will build with a builtin VNC server and a SDL UI frontend
247# where graphical output can be seen.
248# By default libsdl2-native will be built, if you want to use your host's libSDL instead of
249# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below.
250#ASSUME_PROVIDED += "libsdl2-native"
251
252# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds
253# a handy set of menus for controlling the emulator.
254#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+"
255
256#
257# Hash Equivalence
258#
259# Enable support for automatically running a local hash equivalence server and
260# instruct bitbake to use a hash equivalence aware signature generator. Hash
261# equivalence improves reuse of sstate by detecting when a given sstate
262# artifact can be reused as equivalent, even if the current task hash doesn't
263# match the one that generated the artifact.
264#
265# A shared hash equivalent server can be set with "<HOSTNAME>:<PORT>" format
266#
267#BB_HASHSERVE = "auto"
268#BB_SIGNATURE_HANDLER = "OEEquivHash"
269
270#
271# Memory Resident Bitbake
272#
273# Bitbake's server component can stay in memory after the UI for the current command
274# has completed. This means subsequent commands can run faster since there is no need
275# for bitbake to reload cache files and so on. Number is in seconds, after which the
276# server will shut down.
277#
278#BB_SERVER_TIMEOUT = "60"
279
280# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
281# track the version of this file when it was generated. This can safely be ignored if
282# this doesn't mean anything to you.
283CONF_VERSION = "2"