summaryrefslogtreecommitdiffstats
path: root/bitbake/README
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/README')
-rw-r--r--bitbake/README50
1 files changed, 39 insertions, 11 deletions
diff --git a/bitbake/README b/bitbake/README
index 479c376588..e9f4c858ee 100644
--- a/bitbake/README
+++ b/bitbake/README
@@ -7,29 +7,57 @@ One of BitBake's main users, OpenEmbedded, takes this core and builds embedded L
7stacks using a task-oriented approach. 7stacks using a task-oriented approach.
8 8
9For information about Bitbake, see the OpenEmbedded website: 9For information about Bitbake, see the OpenEmbedded website:
10 http://www.openembedded.org/ 10 https://www.openembedded.org/
11 11
12Bitbake plain documentation can be found under the doc directory or its integrated 12Bitbake plain documentation can be found under the doc directory or its integrated
13html version at the Yocto Project website: 13html version at the Yocto Project website:
14 http://yoctoproject.org/documentation 14 https://docs.yoctoproject.org
15
16Bitbake requires Python version 3.8 or newer.
15 17
16Contributing 18Contributing
17------------ 19------------
18 20
19Please refer to 21Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
20http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded 22for full details on how to submit changes.
21for guidelines on how to submit patches, just note that the latter documentation is intended 23
22for OpenEmbedded (and its core) not bitbake patches (bitbake-devel@lists.openembedded.org) 24As a quick guide, patches should be sent to bitbake-devel@lists.openembedded.org
23but in general main guidelines apply. Once the commit(s) have been created, the way to send 25The git command to do that would be:
24the patch is through git-send-email. For example, to send the last commit (HEAD) on current
25branch, type:
26 26
27 git send-email -M -1 --to bitbake-devel@lists.openembedded.org 27 git send-email -M -1 --to bitbake-devel@lists.openembedded.org
28 28
29If you're sending a patch related to the BitBake manual, make sure you copy
30the Yocto Project documentation mailing list:
31
32 git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org
33
29Mailing list: 34Mailing list:
30 35
31 http://lists.openembedded.org/mailman/listinfo/bitbake-devel 36 https://lists.openembedded.org/g/bitbake-devel
32 37
33Source code: 38Source code:
34 39
35 http://git.openembedded.org/bitbake/ 40 https://git.openembedded.org/bitbake/
41
42Testing
43-------
44
45Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
46You can run this with "bitbake-selftest". In particular the fetcher is well covered since
47it has so many corner cases. The datastore has many tests too. Testing with the testsuite is
48recommended before submitting patches, particularly to the fetcher and datastore. We also
49appreciate new test cases and may require them for more obscure issues.
50
51To run the tests "zstd" and "git" must be installed.
52
53The assumption is made that this testsuite is run from an initialized OpenEmbedded build
54environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
55testsuite as follows:
56
57 export PATH=$(pwd)/bin:$PATH
58 bin/bitbake-selftest
59
60The testsuite can alternatively be executed using pytest, e.g. obtained from PyPI (in this
61case, the PATH is configured automatically):
62
63 pytest