Go to file
Joshua Watt ce166ae257 bitbake-hashclient: Improve stress statistics reporting
Improves the way statistics are reported for the stress test. This makes
it easier to compare them to the ping test

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-23 11:27:06 +01:00
bin bitbake-hashclient: Improve stress statistics reporting 2024-05-23 11:27:06 +01:00
classes base.bbclass: fix 'python should use 4 spaces indentation' warnings 2019-12-28 23:50:40 +00:00
conf bitbake.conf: add missing CACHE setting 2024-01-07 17:51:29 +00:00
contrib contrib/vim: Syntax improvements 2023-12-23 16:20:23 +00:00
doc doc/user-manual: Add BB_LOADFACTOR_MAX 2024-04-12 17:23:25 +01:00
lib fetch/npmsw: The fetcher shouldn't have any knowledge of S 2024-05-23 11:27:06 +01:00
.gitattributes .gitattributes: Add to improve git diff for minified css/js files 2019-03-07 12:18:40 +00:00
.gitignore gitignore: ignore runqueue-tests/bitbake-cookerdaemon.log 2021-03-12 16:45:36 +00:00
AUTHORS misc: Update the email address to a working one. 2010-08-07 22:58:47 +08:00
ChangeLog *: Fix typo in documentation 2010-08-03 17:02:43 +02:00
LICENSE bitbake: Add initial pass of SPDX license headers to source code 2019-05-04 10:41:13 +01:00
LICENSE.GPL-2.0-only bitbake: Add initial pass of SPDX license headers to source code 2019-05-04 10:41:13 +01:00
LICENSE.MIT bitbake: Add initial pass of SPDX license headers to source code 2019-05-04 10:41:13 +01:00
MANIFEST.in HEADER: Drop it 2019-05-04 10:41:13 +01:00
README doc: README: simpler link to contributor guide 2024-02-10 14:13:49 +00:00
SECURITY.md SECURITY.md: add file 2023-10-24 12:49:46 +01:00
TODO Linefeed to test commits 2011-10-26 07:48:53 -04:00
toaster-requirements.txt Update toaster-requirements to add django-log-viewer==1.1.7 2023-10-15 09:12:00 +01:00

README

Bitbake
=======

BitBake is a generic task execution engine that allows shell and Python tasks to be run
efficiently and in parallel while working within complex inter-task dependency constraints.
One of BitBake's main users, OpenEmbedded, takes this core and builds embedded Linux software
stacks using a task-oriented approach.

For information about Bitbake, see the OpenEmbedded website:
    https://www.openembedded.org/

Bitbake plain documentation can be found under the doc directory or its integrated
html version at the Yocto Project website:
    https://docs.yoctoproject.org

Bitbake requires Python version 3.8 or newer.

Contributing
------------

Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
for full details on how to submit changes.

As a quick guide, patches should be sent to bitbake-devel@lists.openembedded.org
The git command to do that would be:

    git send-email -M -1 --to bitbake-devel@lists.openembedded.org

If you're sending a patch related to the BitBake manual, make sure you copy
the Yocto Project documentation mailing list:

    git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org

Mailing list:

    https://lists.openembedded.org/g/bitbake-devel

Source code:

    https://git.openembedded.org/bitbake/

Testing
-------

Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions.
You can run this with "bitbake-selftest". In particular the fetcher is well covered since
it has so many corner cases. The datastore has many tests too. Testing with the testsuite is
recommended before submitting patches, particularly to the fetcher and datastore. We also
appreciate new test cases and may require them for more obscure issues.

To run the tests "zstd" and "git" must be installed.

The assumption is made that this testsuite is run from an initialized OpenEmbedded build
environment (i.e. `source oe-init-build-env` is used). If this is not the case, run the
testsuite as follows:

    export PATH=$(pwd)/bin:$PATH
    bin/bitbake-selftest

The testsuite can alternatively be executed using pytest, e.g. obtained from PyPI (in this
case, the PATH is configured automatically):

    pytest