Yocto Project - User contributions [en]

TipsAndTricks/Patching the source for a recipe

2024-03-05T16:47:16Z

Marco Cavallini: Chenged "bitbake" to "devtool build"

= Patching the source for a recipe =

One of the useful things about OpenEmbedded building everything from source is that it's fairly easy to make changes to anything that gets built, but doing so for the first time can be a bit daunting.

As part of building a recipe, OE creates a tmp/work/<architecture>/<recipe>/<version> directory, known as the "work directory". This is where all of the work done to build a recipe takes place. One of the things you'll find in this directory is the source, usually under a subdirectory named <recipename>-<version> or "git" (depending on how the fetched source is provided). The temptation (and what people used to do in the past) is to simply make changes here and then recompile, but there are several reasons why that's not a good idea:

* It's awkward - you have to use <code>bitbake -c compile -f</code> or <code>bitbake -C compile</code> to force recompilation, since the build system doesn't know that you've made any changes
* You can easily lose your changes if you're not careful e.g. running <code>bitbake -c clean</code> will wipe the directory out

Luckily if you're using the fido (1.8) or later release, there's a much better method using the <code>devtool</code> command:

# Run <code>devtool modify <recipename></code>. This will fetch the sources for the recipe and unpack them to a workspace/sources/<recipename> directory and initialise it as a git repository if it isn't already one. If you prefer you can specify your own path, or if you already have your own existing source tree you can specify the path along with the -n option to use that instead of unpacking a new one.
# Make the changes you want to make to the source
# Run a build to test your changes - you can just <code>devtool build <recipename></code> or even build an entire image incorporating the changes assuming a package produced by the recipe is part of an image. There's no need to force anything - the build system will detect changes to the source and recompile as necessary.
# If you wish, test your changes on the target. There's a "devtool deploy-target" command which will copy the files installed at do_install over to the target machine assuming it has network access, and any dependencies are already present in the image.
# Repeat from step 2 as needed until you're happy with the results.
# At this point you will almost certainly want to place your changes in the form of a patch to be applied from the metadata - devtool provides help with this as well. Commit your changes using "git commit" (as many or as few commits as you'd like) and then run either:
#* <code>devtool update-recipe <recipename></code> to update the original recipe - usually appropriate if it's your own recipe or you're submitting the changes back to the upstream layer
#* <code>devtool update-recipe -a <layerpath> <recipename></code> to put your changes in the form of a bbappend to be applied by a different layer. This is usually the desired method if your changes are customisations rather than bugfixes.
# If you're finished working on the recipe, run <code>devtool reset <recipename></code>.

This is just one of the things that devtool can do - it provides some powerful tools to help you maintain recipes and make changes to source code.

Project Users

2020-01-20T10:11:37Z

Marco Cavallini: Adding KOAN software engineering to YP users

It's hard to know which companies or projects use the Yocto Project since there is no requirement to tell us. This list is here to informally collate the companies, projects and products that use the Yocto Project in some way.

= Companies using the Yocto Project =

Semiconductor Vendors:
* AMD (Silver Member)
* ARM (Platinum Member)
* Intel (Platinum Member)
* NXP (Silver Member)
* Qualcomm
* Renesas (Gold Member)
* STMicroelectronics (Silver Member)
* Texas Instruments (Platinum Member)
* Xilinx (Platinum Member)

Operating System Vendors:
* ENEA (Silver Member)
* Linaro (Silver Member)
* Lineo (Silver Member)
* Mentor Graphics (Gold Member)
* Montavista (Silver Member)
* Wind River (Gold Member)

Others:
* Cisco (Platinum Member)
* Comcast (Platinum Member)
* Dell (Silver Member)
* Facebook (Platinum Member)
* Juniper (Gold Member)
* LG (Silver Member)
* Microsoft
* StreamUnlimited Engineering GmbH
* [https://koansoftware.com/ KOAN sas]

= Products that use the Yocto Project =

* Comcast set top boxes
* LG TVs
* [https://www.streamunlimited.com/hardware-modules/ StreamUnlimited hardware modules for voice assistants and connected speakers]

= Projects that use the Yocto Project =

* [https://www.automotivelinux.org/ Automotive Grade Linux (AGL)]
* Comcast RDK
* OpenBMC
* Windows Subsystem Linux (v1+v2)
* [https://oryx-linux.org/ Oryx Linux]
* [https://www.streamunlimited.com/stream-sdk/ StreamSDK for voice assistants and connected speakers]

The Yocto Autobuilder

2019-06-27T12:46:31Z

Marco Cavallini: /* The Yocto AutoBuilder */

== The Yocto AutoBuilder ==

The Yocto AutoBuilder is a buildbot based autobuilder implementation that can be used to build out and test custom distros utilizing OE-Core (either bare or through the poky repository)

The source code can be downloaded from the ['''yocto-autobuilder2''' http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder2/] and [yocto-autobuilder-helper http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder-helper/] repositories.

For details on the design and configuration of the AutoBuilder, refer to the documentation in those repositories.

The yocto-autobuilder maintainer is [[User:Rpurdie | Richard Purdie]]. All patches to the yocto-autobuilder2 should be sent to yocto@yoctoproject.org with "[yocto-autobuilder2]" in the Subject line. Please CC: richard.purdie@linuxfoundation.org.

If you have access to our production autobuilder, please read the documentation on [[How_to_start_a_build_on_the_Autobuilder | how to kick off builds]].

'''NOTE: please use autobuilder2''', autobilder is dead [1], buildbot eight is dead.

[1] http://git.yoctoproject.org/cgit.cgi/yocto-autobuilder/commit/?id=1369545f9819537535e4ab6ebeb49e7b173a8366

=== Resources ===

* [[Accessing Autobuilders]]
* [https://autobuilder.yocto.io/pub/non-release/ non-release build output] -- https://autobuilder.yocto.io/pub/non-release/
* [https://autobuilder.yocto.io/pub/releases/ release build output] -- https://autobuilder.yocto.io/pub/releases/
* [[AutoBuilder Maintenance]]
* [[AutoBuilder Cluster Setup]]
* [[How_to_start_a_build_on_the_Autobuilder |How to Start a Build on the AutoBuilder]]
* [[Frequently Asked Yocto Autobuilder Questions]]
* [[Entropy on Autobuilders]]

=== AutoBuilder Automated Testing ===

The AutoBuilder is able to execute automated testing too when the proper configuration is added. The AutoBuilder relies on what the Yocto Project exposes as automated test tools and it doesn't include support for directly executing tests. The AutoBuilder has been used for test execution (runtime, selftests) in the Yocto Project long before it was chosen as the automated test framework over LAVA.
Instructions on how to add tests to the AutoBuilder [[AutoBuilder/Adding Automated Tests|can be seen here]].

The Yocto Autobuilder

2019-06-27T12:46:07Z

Marco Cavallini: /* The Yocto AutoBuilder */

== The Yocto AutoBuilder ==

The Yocto AutoBuilder is a buildbot based autobuilder implementation that can be used to build out and test custom distros utilizing OE-Core (either bare or through the poky repository)

The source code can be downloaded from the [yocto-autobuilder2 http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder2/] and [yocto-autobuilder-helper http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder-helper/] repositories.

For details on the design and configuration of the AutoBuilder, refer to the documentation in those repositories.

The yocto-autobuilder maintainer is [[User:Rpurdie | Richard Purdie]]. All patches to the yocto-autobuilder2 should be sent to yocto@yoctoproject.org with "[yocto-autobuilder2]" in the Subject line. Please CC: richard.purdie@linuxfoundation.org.

If you have access to our production autobuilder, please read the documentation on [[How_to_start_a_build_on_the_Autobuilder | how to kick off builds]].

'''NOTE: please use autobuilder2''', autobilder is dead [1], buildbot eight is dead.

[1] http://git.yoctoproject.org/cgit.cgi/yocto-autobuilder/commit/?id=1369545f9819537535e4ab6ebeb49e7b173a8366

=== Resources ===

* [[Accessing Autobuilders]]
* [https://autobuilder.yocto.io/pub/non-release/ non-release build output] -- https://autobuilder.yocto.io/pub/non-release/
* [https://autobuilder.yocto.io/pub/releases/ release build output] -- https://autobuilder.yocto.io/pub/releases/
* [[AutoBuilder Maintenance]]
* [[AutoBuilder Cluster Setup]]
* [[How_to_start_a_build_on_the_Autobuilder |How to Start a Build on the AutoBuilder]]
* [[Frequently Asked Yocto Autobuilder Questions]]
* [[Entropy on Autobuilders]]

=== AutoBuilder Automated Testing ===

The AutoBuilder is able to execute automated testing too when the proper configuration is added. The AutoBuilder relies on what the Yocto Project exposes as automated test tools and it doesn't include support for directly executing tests. The AutoBuilder has been used for test execution (runtime, selftests) in the Yocto Project long before it was chosen as the automated test framework over LAVA.
Instructions on how to add tests to the AutoBuilder [[AutoBuilder/Adding Automated Tests|can be seen here]].

The Yocto Autobuilder

2019-06-27T12:45:25Z

Marco Cavallini: /* The Yocto AutoBuilder */

== The Yocto AutoBuilder ==

The Yocto AutoBuilder is a buildbot based autobuilder implementation that can be used to build out and test custom distros utilizing OE-Core (either bare or through the poky repository)

The source code can be downloaded from the [yocto-autobuilder2 http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder2/] and [yocto-autobuilder-helper http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder-helper/] repositories.

For details on the design and configuration of the AutoBuilder, refer to the documentation in those repositories.

The yocto-autobuilder maintainer is [[User:Rpurdie | Richard Purdie]]. All patches to the yocto-autobuilder2 should be sent to yocto@yoctoproject.org with "[yocto-autobuilder2]" in the Subject line. Please CC: richard.purdie@linuxfoundation.org.

If you have access to our production autobuilder, please read the documentation on [[How_to_start_a_build_on_the_Autobuilder | how to kick off builds]].

'''NOTE: please use autobuilder2''', autobilder [1] is dead is dead, buildbot eight is dead.

[1] http://git.yoctoproject.org/cgit.cgi/yocto-autobuilder/commit/?id=1369545f9819537535e4ab6ebeb49e7b173a8366

=== Resources ===

* [[Accessing Autobuilders]]
* [https://autobuilder.yocto.io/pub/non-release/ non-release build output] -- https://autobuilder.yocto.io/pub/non-release/
* [https://autobuilder.yocto.io/pub/releases/ release build output] -- https://autobuilder.yocto.io/pub/releases/
* [[AutoBuilder Maintenance]]
* [[AutoBuilder Cluster Setup]]
* [[How_to_start_a_build_on_the_Autobuilder |How to Start a Build on the AutoBuilder]]
* [[Frequently Asked Yocto Autobuilder Questions]]
* [[Entropy on Autobuilders]]

=== AutoBuilder Automated Testing ===

The AutoBuilder is able to execute automated testing too when the proper configuration is added. The AutoBuilder relies on what the Yocto Project exposes as automated test tools and it doesn't include support for directly executing tests. The AutoBuilder has been used for test execution (runtime, selftests) in the Yocto Project long before it was chosen as the automated test framework over LAVA.
Instructions on how to add tests to the AutoBuilder [[AutoBuilder/Adding Automated Tests|can be seen here]].

The Yocto Autobuilder

2018-08-29T12:53:59Z

Marco Cavallini: /* The Yocto AutoBuilder */

== The Yocto AutoBuilder ==

The Yocto AutoBuilder is a buildbot based autobuilder implementation that can be used to build out and test custom distros utilizing OE-Core (either bare or through the poky repository)

The source code can be downloaded from the [yocto-autobuilder http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder/] repository.

For details on the design and configuration of the AutoBuilder, refer to the '''''YoctoAutobuilderDevelopersDocument.html''''' document in the ''docs'' directory of the yocto-autobuilder git repo.

The yocto-autobuilder maintainer is [[User:Joshua_Lock | Joshua Lock]]. All patches to the yocto-autobuilder should be sent to yocto@yoctoproject.org with "[yocto-autobuilder]" in the Subject line. Please CC: joshua.g.lock@linux.intel.com.

If you have access to our production autobuilder, please read the documentation on [[How_to_start_a_build_on_the_Autobuilder | how to kick off builds]].

=== Resources ===

* [[Accessing Autobuilders]]
* [http://autobuilder.yoctoproject.org/pub/nightly/ Nightly build output] -- http://autobuilder.yoctoproject.org/pub/nightly/
* [[AutoBuilder Maintenance]]
* [[AutoBuilder Cluster Setup]]
* [[How_to_start_a_build_on_the_Autobuilder |How to Start a Build on the AutoBuilder]]
* [[Frequently Asked Yocto Autobuilder Questions]]
* [[Entropy on Autobuilders]]

=== AutoBuilder Automated Testing ===

The AutoBuilder is able to execute automated testing too when the proper configuration is added. The AutoBuilder relies on what the Yocto Project exposes as automated test tools and it doesn't include support for directly executing tests. The AutoBuilder has been used for test execution (runtime, selftests) in the Yocto Project long before it was chosen as the automated test framework over LAVA.
Instructions on how to add tests to the AutoBuilder [[AutoBuilder/Adding Automated Tests|can be seen here]].