README 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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. Contributing
  13. ------------
  14. Please refer to
  15. https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
  16. for guidelines on how to submit patches, just note that the latter documentation is intended
  17. for OpenEmbedded (and its core) not bitbake patches (bitbake-devel@lists.openembedded.org)
  18. but in general main guidelines apply. Once the commit(s) have been created, the way to send
  19. the patch is through git-send-email. For example, to send the last commit (HEAD) on current
  20. branch, type:
  21. git send-email -M -1 --to bitbake-devel@lists.openembedded.org
  22. If you're sending a patch related to the BitBake manual, make sure you copy
  23. the Yocto Project documentation mailing list:
  24. git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org
  25. Mailing list:
  26. https://lists.openembedded.org/g/bitbake-devel
  27. Source code:
  28. https://git.openembedded.org/bitbake/
  29. Testing:
  30. Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
  31. You can run this with "bitbake-selftest". In particular the fetcher is well covered since
  32. it has so many corner cases. The datastore has many tests too. Testing with the testsuite is
  33. recommended before submitting patches, particularly to the fetcher and datastore. We also
  34. appreciate new test cases and may require them for more obscure issues.