README 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. Bitbake
  2. =======
  3. BitBake is a generic task execution engine that allows shell and Python tasks to be run
  4. efficiently and in parallel while working within complex inter-task dependency constraints.
  5. One of BitBake's main users, OpenEmbedded, takes this core and builds embedded Linux software
  6. stacks using a task-oriented approach.
  7. For information about Bitbake, see the OpenEmbedded website:
  8. https://www.openembedded.org/
  9. Bitbake plain documentation can be found under the doc directory or its integrated
  10. html version at the Yocto Project website:
  11. https://docs.yoctoproject.org
  12. Bitbake requires Python version 3.8 or newer.
  13. Contributing
  14. ------------
  15. Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
  16. for full details on how to submit changes.
  17. As a quick guide, patches should be sent to bitbake-devel@lists.openembedded.org
  18. The git command to do that would be:
  19. git send-email -M -1 --to bitbake-devel@lists.openembedded.org
  20. If you're sending a patch related to the BitBake manual, make sure you copy
  21. the Yocto Project documentation mailing list:
  22. git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org
  23. Mailing list:
  24. https://lists.openembedded.org/g/bitbake-devel
  25. Source code:
  26. https://git.openembedded.org/bitbake/
  27. Testing
  28. -------
  29. Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
  30. You can run this with "bitbake-selftest". In particular the fetcher is well covered since
  31. it has so many corner cases. The datastore has many tests too. Testing with the testsuite is
  32. recommended before submitting patches, particularly to the fetcher and datastore. We also
  33. appreciate new test cases and may require them for more obscure issues.
  34. To run the tests "zstd" and "git" must be installed.
  35. The assumption is made that this testsuite is run from an initialized OpenEmbedded build
  36. environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
  37. testsuite as follows:
  38. export PATH=$(pwd)/bin:$PATH
  39. bin/bitbake-selftest
  40. The testsuite can alternatively be executed using pytest, e.g. obtained from PyPI (in this
  41. case, the PATH is configured automatically):
  42. pytest