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