Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 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 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 Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 31 | #MACHINE ?= "beaglebone-yocto" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 32 | #MACHINE ?= "genericx86" |
| 33 | #MACHINE ?= "genericx86-64" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 34 | #MACHINE ?= "edgerouter" |
| 35 | # |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame] | 36 | # This sets the default machine to be qemux86-64 if no other machine is selected: |
| 37 | MACHINE ??= "qemux86-64" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 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. |
| 85 | # Ultimately when creating custom policy, people will likely end up subclassing |
| 86 | # these defaults. |
| 87 | # |
| 88 | DISTRO ?= "poky" |
| 89 | # As an example of a subclass there is a "bleeding" edge policy configuration |
| 90 | # where many versions are set to the absolute latest code from the upstream |
| 91 | # 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 | # |
| 98 | # 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 |
| 100 | # 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" |
| 106 | # We default to rpm: |
| 107 | PACKAGE_CLASSES ?= "package_rpm" |
| 108 | |
| 109 | # |
| 110 | # SDK target architecture |
| 111 | # |
| 112 | # 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 |
| 114 | # running the build on (i.e. building i686 packages on an x86_64 host). |
| 115 | # Supported values are i686 and x86_64 |
| 116 | #SDKMACHINE ?= "i686" |
| 117 | |
| 118 | # |
| 119 | # Extra image configuration defaults |
| 120 | # |
| 121 | # The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated |
| 122 | # images. Some of these options are added to certain image types automatically. The |
| 123 | # variable can contain the following options: |
| 124 | # "dbg-pkgs" - add -dbg packages for all installed packages |
| 125 | # (adds symbol information for debugging/profiling) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 126 | # "src-pkgs" - add -src packages for all installed packages |
| 127 | # (adds source code for debugging) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 128 | # "dev-pkgs" - add -dev packages for all installed packages |
| 129 | # (useful if you want to develop against libs in the image) |
| 130 | # "ptest-pkgs" - add -ptest packages for all ptest-enabled packages |
| 131 | # (useful if you want to run the package test suites) |
| 132 | # "tools-sdk" - add development tools (gcc, make, pkgconfig etc.) |
| 133 | # "tools-debug" - add debugging tools (gdb, strace) |
| 134 | # "eclipse-debug" - add Eclipse remote debugging support |
| 135 | # "tools-profile" - add profiling tools (oprofile, lttng, valgrind) |
| 136 | # "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.) |
| 137 | # "debug-tweaks" - make an image suitable for development |
| 138 | # e.g. ssh root access has a blank password |
| 139 | # There are other application targets that can be used here too, see |
| 140 | # meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details. |
| 141 | # We default to enabling the debugging tweaks. |
| 142 | EXTRA_IMAGE_FEATURES ?= "debug-tweaks" |
| 143 | |
| 144 | # |
| 145 | # Additional image features |
| 146 | # |
| 147 | # The following is a list of additional classes to use when building images which |
| 148 | # enable extra features. Some available options which can be included in this variable |
| 149 | # are: |
| 150 | # - 'buildstats' collect build statistics |
| 151 | # - 'image-mklibs' to reduce shared library files size for an image |
| 152 | # - 'image-prelink' in order to prelink the filesystem image |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 153 | # NOTE: if listing mklibs & prelink both, then make sure mklibs is before prelink |
| 154 | # NOTE: mklibs also needs to be explicitly enabled for a given image, see local.conf.extended |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 155 | USER_CLASSES ?= "buildstats image-mklibs image-prelink" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 156 | |
| 157 | # |
| 158 | # Runtime testing of images |
| 159 | # |
| 160 | # The build system can test booting virtual machine images under qemu (an emulator) |
Brad Bishop | a5c52ff | 2018-11-23 10:55:50 +1300 | [diff] [blame] | 161 | # after any root filesystems are created and run tests against those images. It can also |
| 162 | # run tests against any SDK that are built. To enable this uncomment these lines. |
| 163 | # See classes/test{image,sdk}.bbclass for further details. |
| 164 | #IMAGE_CLASSES += "testimage testsdk" |
| 165 | #TESTIMAGE_AUTO_qemuall = "1" |
| 166 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 167 | # |
| 168 | # Interactive shell configuration |
| 169 | # |
| 170 | # Under certain circumstances the system may need input from you and to do this it |
| 171 | # can launch an interactive shell. It needs to do this since the build is |
| 172 | # multithreaded and needs to be able to handle the case where more than one parallel |
| 173 | # process may require the user's attention. The default is iterate over the available |
| 174 | # terminal types to find one that works. |
| 175 | # |
| 176 | # Examples of the occasions this may happen are when resolving patches which cannot |
| 177 | # be applied, to use the devshell or the kernel menuconfig |
| 178 | # |
| 179 | # Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none |
| 180 | # Note: currently, Konsole support only works for KDE 3.x due to the way |
| 181 | # newer Konsole versions behave |
| 182 | #OE_TERMINAL = "auto" |
| 183 | # By default disable interactive patch resolution (tasks will just fail instead): |
| 184 | PATCHRESOLVE = "noop" |
| 185 | |
| 186 | # |
| 187 | # Disk Space Monitoring during the build |
| 188 | # |
| 189 | # Monitor the disk space during the build. If there is less that 1GB of space or less |
| 190 | # than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully |
| 191 | # shutdown the build. If there is less that 100MB or 1K inodes, perform a hard abort |
| 192 | # of the build. The reason for this is that running completely out of space can corrupt |
| 193 | # files and damages the build in ways which may not be easily recoverable. |
| 194 | # It's necesary to monitor /tmp, if there is no space left the build will fail |
| 195 | # with very exotic errors. |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 196 | BB_DISKMON_DIRS ??= "\ |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 197 | STOPTASKS,${TMPDIR},1G,100K \ |
| 198 | STOPTASKS,${DL_DIR},1G,100K \ |
| 199 | STOPTASKS,${SSTATE_DIR},1G,100K \ |
| 200 | STOPTASKS,/tmp,100M,100K \ |
| 201 | ABORT,${TMPDIR},100M,1K \ |
| 202 | ABORT,${DL_DIR},100M,1K \ |
| 203 | ABORT,${SSTATE_DIR},100M,1K \ |
| 204 | ABORT,/tmp,10M,1K" |
| 205 | |
| 206 | # |
| 207 | # Shared-state files from other locations |
| 208 | # |
| 209 | # As mentioned above, shared state files are prebuilt cache data objects which can |
| 210 | # used to accelerate build time. This variable can be used to configure the system |
| 211 | # to search other mirror locations for these objects before it builds the data itself. |
| 212 | # |
| 213 | # This can be a filesystem directory, or a remote url such as http or ftp. These |
| 214 | # would contain the sstate-cache results from previous builds (possibly from other |
| 215 | # machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the |
| 216 | # cache locations to check for the shared objects. |
| 217 | # NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH |
| 218 | # at the end as shown in the examples below. This will be substituted with the |
| 219 | # correct path within the directory structure. |
| 220 | #SSTATE_MIRRORS ?= "\ |
| 221 | #file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ |
| 222 | #file://.* file:///some/local/dir/sstate/PATH" |
| 223 | |
Brad Bishop | 316dfdd | 2018-06-25 12:45:53 -0400 | [diff] [blame] | 224 | # |
| 225 | # Yocto Project SState Mirror |
| 226 | # |
| 227 | # The Yocto Project has prebuilt artefacts available for its releases, you can enable |
| 228 | # use of these by uncommenting the following line. This will mean the build uses |
| 229 | # the network to check for artefacts at the start of builds, which does slow it down |
| 230 | # equally, it will also speed up the builds by not having to build things if they are |
| 231 | # present in the cache. It assumes you can download something faster than you can build it |
| 232 | # which will depend on your network. |
| 233 | # |
| 234 | #SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/2.5/PATH;downloadfilename=PATH" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 235 | |
| 236 | # |
| 237 | # Qemu configuration |
| 238 | # |
Brad Bishop | 08902b0 | 2019-08-20 09:16:51 -0400 | [diff] [blame] | 239 | # By default native qemu will build with a builtin VNC server where graphical output can be |
Brad Bishop | 79641f2 | 2019-09-10 07:20:22 -0400 | [diff] [blame] | 240 | # seen. The line below enables the SDL UI frontend too. |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 241 | PACKAGECONFIG_append_pn-qemu-system-native = " sdl" |
Brad Bishop | 79641f2 | 2019-09-10 07:20:22 -0400 | [diff] [blame] | 242 | # 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. |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 244 | #ASSUME_PROVIDED += "libsdl2-native" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 245 | |
Brad Bishop | 79641f2 | 2019-09-10 07:20:22 -0400 | [diff] [blame] | 246 | # 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 | |
Brad Bishop | 00e122a | 2019-10-05 11:10:57 -0400 | [diff] [blame] | 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 | |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 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" |
| 273 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 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. |
| 277 | CONF_VERSION = "1" |