xref: /OK3568_Linux_fs/yocto/bitbake/README (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunBitbake
2*4882a593Smuzhiyun=======
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunBitBake is a generic task execution engine that allows shell and Python tasks to be run
5*4882a593Smuzhiyunefficiently and in parallel while working within complex inter-task dependency constraints.
6*4882a593SmuzhiyunOne of BitBake's main users, OpenEmbedded, takes this core and builds embedded Linux software
7*4882a593Smuzhiyunstacks using a task-oriented approach.
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunFor information about Bitbake, see the OpenEmbedded website:
10*4882a593Smuzhiyun    https://www.openembedded.org/
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunBitbake plain documentation can be found under the doc directory or its integrated
13*4882a593Smuzhiyunhtml version at the Yocto Project website:
14*4882a593Smuzhiyun    https://docs.yoctoproject.org
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunContributing
17*4882a593Smuzhiyun------------
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunPlease refer to
20*4882a593Smuzhiyunhttps://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
21*4882a593Smuzhiyunfor guidelines on how to submit patches, just note that the latter documentation is intended
22*4882a593Smuzhiyunfor OpenEmbedded (and its core) not bitbake patches (bitbake-devel@lists.openembedded.org)
23*4882a593Smuzhiyunbut in general main guidelines apply. Once the commit(s) have been created, the way to send
24*4882a593Smuzhiyunthe patch is through git-send-email. For example, to send the last commit (HEAD) on current
25*4882a593Smuzhiyunbranch, type:
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun    git send-email -M -1 --to bitbake-devel@lists.openembedded.org
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunMailing list:
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun    https://lists.openembedded.org/g/bitbake-devel
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunSource code:
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun    https://git.openembedded.org/bitbake/
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunTesting:
38*4882a593Smuzhiyun
39*4882a593SmuzhiyunBitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
40*4882a593SmuzhiyunYou can run this with "bitbake-selftest". In particular the fetcher is well covered since
41*4882a593Smuzhiyunit has so many corner cases. The datastore has many tests too. Testing with the testsuite is
42*4882a593Smuzhiyunrecommended before submitting patches, particularly to the fetcher and datastore. We also
43*4882a593Smuzhiyunappreciate new test cases and may require them for more obscure issues.
44