2 # Sanity check the users setup for common misconfigurations
5 BB_MIN_VERSION = "1.3.3"
7 def raise_sanity_error(msg):
9 bb.fatal("Openembedded's config sanity checker detected a potential misconfiguration.\nEither fix cause of this error or at your own risk disable the checker (see sanity.conf).\n%s" % msg)
11 def check_conf_exists(fn, data):
15 fn = bb.data.expand(fn, data)
16 vbbpath = bb.data.getVar("BBPATH", data)
18 bbpath += vbbpath.split(":")
20 currname = os.path.join(bb.data.expand(p, data), fn)
21 if os.access(currname, os.R_OK):
25 addhandler check_sanity_eventhandler
26 python check_sanity_eventhandler() {
27 from bb import note, error, data, __version__
28 from bb.event import Handled, NotHandled, getName
29 from distutils.version import LooseVersion
32 sanity_checked = bb.data.getVar('SANITY_CHECKED', e.data)
33 if sanity_checked == "1":
36 # Check the bitbake version meets minimum requirements
37 minversion = bb.data.getVar('BB_MIN_VERSION', e.data , True)
39 # Hack: BB_MIN_VERSION hasn't been parsed yet so return
40 # and wait for the next call
43 if (LooseVersion(bb.__version__) < LooseVersion(minversion)):
44 raise_sanity_error('Bitbake version %s is required and version %s was found' % (minversion, bb.__version__))
46 # Check TARGET_ARCH is set
47 if bb.data.getVar('TARGET_ARCH', e.data, True) == 'INVALID':
48 raise_sanity_error('Please set TARGET_ARCH directly, or choose a MACHINE or DISTRO that does so.')
50 # Check TARGET_OS is set
51 if bb.data.getVar('TARGET_OS', e.data, True) == 'INVALID':
52 raise_sanity_error('Please set TARGET_OS directly, or choose a MACHINE or DISTRO that does so.')
54 # Check user doesn't have ASSUME_PROVIDED = instead of += in local.conf
55 if "diffstat-native" not in bb.data.getVar('ASSUME_PROVIDED', e.data, True).split():
56 raise_sanity_error('Please use ASSUME_PROVIDED +=, not ASSUME_PROVIDED = in your local.conf')
58 # Check the MACHINE is valid
59 if not check_conf_exists("conf/machine/${MACHINE}.conf", e.data):
60 raise_sanity_error('Please set a valid MACHINE in your local.conf')
62 # Check the distro is valid
63 if not check_conf_exists("conf/distro/${DISTRO}.conf", e.data):
64 raise_sanity_error('Please set a valid DISTRO in your local.conf')
66 bb.data.setVar('SANITY_CHECKED', "1", e.data)