Difference between revisions of "Buildroot"

From eLinux.org
Jump to: navigation, search
(Important)
(List of forks)
 
(14 intermediate revisions by 2 users not shown)
Line 15: Line 15:
  
 
Upcoming:
 
Upcoming:
* [[Buildroot:RegularVirtualMeeting | Regular virtual meeting]], starting September 2020
+
* [[Buildroot:DeveloperDaysFOSDEM2023 | Buildroot Developer Days]], 6-8 February 2023, Brussels, Belgium, after [https://fosdem.org/2023/ FOSDEM]
  
 
Past:
 
Past:
 +
* [[Buildroot:DeveloperDaysELCE2022 | Buildroot Developer Days]], 17-18 September 2022, Dublin, Ireland, after [https://events.linuxfoundation.org/open-source-summit-europe/about/embedded-linux-conference/ ELCE]
 
* [[Buildroot:VirtualDeveloperDaysSummer2020 | Virtual Buildroot Developer Days]], July 27, August 28, August 29, 2020
 
* [[Buildroot:VirtualDeveloperDaysSummer2020 | Virtual Buildroot Developer Days]], July 27, August 28, August 29, 2020
 
* [[Buildroot:DeveloperDaysFOSDEM2020 | Buildroot Developer Days]], 3-5 February 2020, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 
* [[Buildroot:DeveloperDaysFOSDEM2020 | Buildroot Developer Days]], 3-5 February 2020, Brussels, Belgium, after [http://fosdem.org FOSDEM]
Line 50: Line 51:
 
* [http://elcabsna2014.sched.org/event/ce9732e662300bace37607a6adacf82b Buildroot: what's new], Thomas Petazzoni, Embedded Linux Conference, 1 May 2014, San Jose, United States. [http://elinux.org/images/1/1d/Petazzoni-buildroot-whats-new.pdf Slides], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot.webm HD video], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot-450p.webm Low-res video], [http://events.linuxfoundation.org/sites/events/files/Buildroot%20What%27s%20New%20-%20Thomas%20Petazzoni-%20Free%20Electrons.mp3 Audio only]
 
* [http://elcabsna2014.sched.org/event/ce9732e662300bace37607a6adacf82b Buildroot: what's new], Thomas Petazzoni, Embedded Linux Conference, 1 May 2014, San Jose, United States. [http://elinux.org/images/1/1d/Petazzoni-buildroot-whats-new.pdf Slides], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot.webm HD video], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot-450p.webm Low-res video], [http://events.linuxfoundation.org/sites/events/files/Buildroot%20What%27s%20New%20-%20Thomas%20Petazzoni-%20Free%20Electrons.mp3 Audio only]
 
* "Buildroot: what is new", Peter Korsgaard, Embedded Linux Conference Europe, 25 October 2013, Edinburgh, UK. [http://elinux.org/images/2/23/Buildroot-whats-new-elce2013.pdf Slides], [https://www.youtube.com/watch?v=0G_yJ50RA3I Video].
 
* "Buildroot: what is new", Peter Korsgaard, Embedded Linux Conference Europe, 25 October 2013, Edinburgh, UK. [http://elinux.org/images/2/23/Buildroot-whats-new-elce2013.pdf Slides], [https://www.youtube.com/watch?v=0G_yJ50RA3I Video].
 
==Accounting==
 
 
This section gathers all the income and expenses of the Buildroot project.
 
 
Current balance: + €381.04
 
 
* 2015-01-08: + €423.14 : Google paid €423.14 ($500) for mentoring a student for the GSoC 2014
 
* 2016-02-07: - € 42.10 : thank-you gift to Niel for helping host the DevDays in Brussels the past few years (T-Shirt: €24.50, Mug: €10.00, shipping: €14.50, rebate: €6.90)
 
 
''Notes: until we have a legal entity representing Buildroot, that money is held by Yann E. MORIN on behalf the Buildroot project. Accounting is handled in Euro. Update 2017-05-14: funds have been transfered to the association's account.''
 
  
 
==List of forks==
 
==List of forks==
  
 +
* [https://batocera.org/ Batocera.linux] is an open-source and completely free retro-gaming distribution.
 
* [https://github.com/home-assistant/operating-system Home Assistant Operating System]. Home Assistant Operating System (formerly HassOS) is an operating system optimized for hosting Home Assistant and its Add-ons.
 
* [https://github.com/home-assistant/operating-system Home Assistant Operating System]. Home Assistant Operating System (formerly HassOS) is an operating system optimized for hosting Home Assistant and its Add-ons.
 
* [https://github.com/openil/openil OpenIL]. OpenIL is an open source project based on Buildroot and designed for embedded industrial solution.
 
* [https://github.com/openil/openil OpenIL]. OpenIL is an open source project based on Buildroot and designed for embedded industrial solution.
 
* [https://github.com/nezticle/RaspberryPi-BuildRoot Bsquask SDK]. A Rasberry-Pi related fork.
 
* [https://github.com/nezticle/RaspberryPi-BuildRoot Bsquask SDK]. A Rasberry-Pi related fork.
* [https://github.com/NextThingCo/CHIP-buildroot C.H.I.P. Buildroot] NextThing fork for the 9$ computer
 
* [https://github.com/NextThingCo/gadget-buildroot Gadget Buildroot] Yet another NextThing fork
 
 
* [https://github.com/albertd/buildroot-rpi]. Another RPi related fork, with a lot of focus on Qt5 and GStreamer (appears to be defunct).
 
* [https://github.com/albertd/buildroot-rpi]. Another RPi related fork, with a lot of focus on Qt5 and GStreamer (appears to be defunct).
 
* [https://github.com/Openwide-Ingenierie/buildroot-submodule Buildroot Submodule]. Not a fork, but a convenience layer on top of buildroot.
 
* [https://github.com/Openwide-Ingenierie/buildroot-submodule Buildroot Submodule]. Not a fork, but a convenience layer on top of buildroot.
Line 77: Line 66:
 
This is a list of improvements that we would like to see in buildroot.  Feel free to add suggestions here.  If you're working on one of these items, put your name and the date behind it, to avoid duplicate work.
 
This is a list of improvements that we would like to see in buildroot.  Feel free to add suggestions here.  If you're working on one of these items, put your name and the date behind it, to avoid duplicate work.
  
There are a number of patches that have been determined to be useful but for various reasons nobody currently has time to review or test them. Anybody, especially a person new to buildroot, is welcome to adopt these patches and resubmit them to the mailing list. These patches can be viewed by looking at the following link - http://patchwork.ozlabs.org/project/buildroot/list/?state=1&delegate=7151
+
There are a number of patches that have been determined to be useful but for various reasons nobody currently has time to review or test them. Anybody, especially a person new to buildroot, is welcome to adopt these patches and resubmit them to the mailing list.
 +
 
 +
=== Perpetual work ===
 +
 
 +
Some jobs are never finished. When you have a bit of uninterrupted time you would like to spend on Buildroot, you can pick one of these things.
 +
 
 +
==== Autobuild failures ====
 +
 
 +
The [http://autobuild.buildroot.net/?status=NOK autobuild failures] are random configurations for which the build fails. This is what we want to fix. A summary of failures is [https://lore.kernel.org/buildroot/?q=autobuild.buildroot.net+Daily+results sent daily to the mailing list], this gives a good summary of the most frequently failing packages.
 +
 
 +
* Go to the failing output ("end log" link) and see if it's an error message that you can make sense of. Often you can't, then just skip it and look for something else.
 +
* Check on [https://patchwork.ozlabs.org/project/buildroot/ patchwork] if a fix was already posted. Also check in recent commit history if a fix was already committed. Also ask [https://buildroot.org/support.html on IRC] if someone is working on it.
 +
* Reproduce the issue with the [https://git.buildroot.org/buildroot-test/tree/utils/br-reproduce-build br-reproduce-build script]. However, it is often easier to first attempt to reproduce it by simply downloading the defconfig as <code>.config</code>, run <code>make olddefconfig</code>, then <code>make <the package that fails></code>. Not all issues can be reproduced this way however! Also, if the failing configuration was using a Buildroot toolchain rather than an external toolchain, it can be worth to first try to reproduce with an external toolchain (which reduces the build time by quite a lot).
 +
* Produce a fix. Here are some hints.
 +
** Perhaps the package simply doesn't support that configuration (target architecture, libc type, static build, threads, GCC version) and a dependency has to be added in Config.in.
 +
** Sometimes a fix was already found by someone else and sent upstream, so check its bugs list, pull requests and recent commits. Also check if OpenEmbedded has a fix already.
 +
** Sometimes a similar issue was recently fixed for another package, so you can <code>git log --grep '<some part of the error message>'</code>.
 +
* Test the fix with the actual configuration (so no switching to external toolchain any more). Do a full clean build.
 +
* Check your changes with the <code>utils/check-package</code> script.
 +
* Post your fix according to [https://buildroot.org/downloads/manual/manual.html#submitting-patches the contribution guidelines] in the manual.
 +
 
 +
See [https://git.buildroot.org/buildroot/commit/?h=2022.05.x&id=2cbcdbf0add46da55020eb56b5e4b974b44e958b this commit] for an example of what the commit message should look like. Important is to have:
 +
* the compilation error;
 +
* the Fixes: line;
 +
* your Signed-off-by.
 +
 
 +
==== Update CVE exceptions ====
 +
 
 +
Buildroot keeps track of which CVEs apply to each package, based on a CPE ID. However, many CVEs don't actually apply. In particular very old CVEs are likely not to be applicable to the version currently shipped in Buildroot.
 +
 
 +
* Look at [http://autobuild.buildroot.net/stats/master.html the package statistics]. Sort by "CVEs". Look for a package with old CVEs.
 +
* For each CVE, check if it really applies.
 +
* If not, update the package's <code>FOO_IGNORE_CVES</code> with the CVE to ignore. Commit with a commit message that explains in detail why the CVE can be ignored. [https://gitlab.com/buildroot.org/buildroot/-/commit/8ae9156d8b730689484927fba2ec2fa6c1dc0433 Example commit message].
 +
* If the CVE really applies, check if there is an upstream patch fixing it.
 +
* Check your changes with the <code>utils/check-package</code> script.
 +
* Post your fix according to [https://buildroot.org/downloads/manual/manual.html#submitting-patches the contribution guidelines] in the manual.
  
 
=== Packages ===
 
=== Packages ===
Line 85: Line 109:
 
==== Important ====
 
==== Important ====
  
 +
* Instead of building the Go compiler, add support for using a pre-compiled Go compiler, like we do for Rust
 +
* Instead of building host-nodejs, add support for using a pre-compiled NodeJS for the host
 
* Improve the imx-gpu-viv package to not install everything. See https://lore.kernel.org/buildroot/20210805233615.4e69d63d@windsurf/T/#u
 
* Improve the imx-gpu-viv package to not install everything. See https://lore.kernel.org/buildroot/20210805233615.4e69d63d@windsurf/T/#u
  
 
==== Nice to have ====
 
==== Nice to have ====
  
 +
* Extend support/scripts/setlocalversion to include the git/hg version(s) of BR2_EXTERNAL.
 
* Create a package for the Qt5 demo/benchmark application at https://github.com/prabindh/xgxperf.
 
* Create a package for the Qt5 demo/benchmark application at https://github.com/prabindh/xgxperf.
 
* Packages proposed in bug reports (often with patch)
 
* Packages proposed in bug reports (often with patch)
Line 104: Line 131:
 
=== Documentation ===
 
=== Documentation ===
  
 +
* Convert the documentation + the generation workflow from current asciidoc to either markdown or ReStructuredText (people are nowadays more used to that syntax, and they are formatted directly when viewed in gitlab/github).
 
* [[Buildroot how to contribute | Document how to contribute]] (how often to repost, what to expect, ...) [[Buildroot how to contribute | basic guide]]  
 
* [[Buildroot how to contribute | Document how to contribute]] (how often to repost, what to expect, ...) [[Buildroot how to contribute | basic guide]]  
 
* Document that package patches should be sent upstream
 
* Document that package patches should be sent upstream
  
 
=== Core Buildroot infrastructure ===
 
=== Core Buildroot infrastructure ===
 +
 +
* Cargo and Go post-process handling for vendoring
 +
** Add support for tarball formats other than gz
 +
 +
* Cargo post-process handling for vendoring
 +
** Either replace "cargo install" by manual installation of files, or ensure that "cargo install" doesn't rebuild things. See https://lore.kernel.org/buildroot/20220106210000.397694-1-thomas.petazzoni@bootlin.com/T/#m2fe31f718c45675f7fb52d001e75cc0386db8aee
 +
** Use more environment variables when calling cargo, to avoid using a cargo configuration file. See https://lore.kernel.org/buildroot/20220106210000.397694-1-thomas.petazzoni@bootlin.com/T/#m8dc0e19638fc1f2c36cac7bba5de615a2a671dc1
  
 
* Investigate adding support for [https://github.com/icecc ICECC]. See also https://www.pengutronix.de/en/2018-09-13-fixing-icecc.html.
 
* Investigate adding support for [https://github.com/icecc ICECC]. See also https://www.pengutronix.de/en/2018-09-13-fixing-icecc.html.
 
* Make it possible to use kernel headers that are more recent than the options we have in Buildroot. Cfr. Arnout's comment in http://patchwork.ozlabs.org/patch/1096256.
 
  
 
* Several improvements are possible in the download infrastructure (even after all the improvements that were already done):
 
* Several improvements are possible in the download infrastructure (even after all the improvements that were already done):
Line 118: Line 151:
  
 
* Locale handling is broken: it doesn't take into account the alias file when purging aliases. See [http://lists.busybox.net/pipermail/buildroot/2013-December/084724.html this mail from patchwork cleanup #3] and [http://patchwork.ozlabs.org/patch/188623/ this patch that also fixes a locale problem, but not everything]. Tests for this are also required.
 
* Locale handling is broken: it doesn't take into account the alias file when purging aliases. See [http://lists.busybox.net/pipermail/buildroot/2013-December/084724.html this mail from patchwork cleanup #3] and [http://patchwork.ozlabs.org/patch/188623/ this patch that also fixes a locale problem, but not everything]. Tests for this are also required.
 
* It would be nice to add a br-configure script in host/usr/bin for autotools-based packages.  Run ...BUILDROOTSDK/usr/bin/br-configure --enable-foo --disable-bar, and the br-configure script would call the ./configure script in the current directory passing all the right options (--host, and all environment variables CC, LD, AS, AR and such).
 
  
 
* Add instrumentation scripts to analyse package installed files:
 
* Add instrumentation scripts to analyse package installed files:
Line 142: Line 173:
 
* It would be nice if there was a make target to reinstall everything to the target (i.e. remove all the target-installed stamps, remove the root stamp, maybe remove the target too).  However, what is missing is the copying of the toolchain support files (libc.so etc.).  It's not obvious that this can be done in a reliable way.
 
* It would be nice if there was a make target to reinstall everything to the target (i.e. remove all the target-installed stamps, remove the root stamp, maybe remove the target too).  However, what is missing is the copying of the toolchain support files (libc.so etc.).  It's not obvious that this can be done in a reliable way.
 
* To facilitate debugging, all packages should be installed to the staging directory. The target directory should in fact be a subset of the staging directory. See the FOSDEM 2013 discussion at http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013, and the discussion around patch http://patchwork.ozlabs.org/patch/252718/. This is however a significant change in Buildroot, so probably difficult to implement, and will raise a number of quite complicated questions.
 
* To facilitate debugging, all packages should be installed to the staging directory. The target directory should in fact be a subset of the staging directory. See the FOSDEM 2013 discussion at http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013, and the discussion around patch http://patchwork.ozlabs.org/patch/252718/. This is however a significant change in Buildroot, so probably difficult to implement, and will raise a number of quite complicated questions.
 
=== Web site ===
 
 
Do we want to extend https://buildroot.org/support.html to promote consultants or companies that are involved in the development of Buildroot?
 
Something like https://www.yoctoproject.org/community/consultants .
 
What would be the selection criteria?
 

Latest revision as of 11:09, 22 February 2023

Buildroot is a nice, simple, and efficient embedded Linux build system.

Important links

Developer days

Upcoming:

Past:

Talks

This section gathers the list of talks given about Buildroot, as well as the slides and video when available.

Past:

List of forks

  • Batocera.linux is an open-source and completely free retro-gaming distribution.
  • Home Assistant Operating System. Home Assistant Operating System (formerly HassOS) is an operating system optimized for hosting Home Assistant and its Add-ons.
  • OpenIL. OpenIL is an open source project based on Buildroot and designed for embedded industrial solution.
  • Bsquask SDK. A Rasberry-Pi related fork.
  • [1]. Another RPi related fork, with a lot of focus on Qt5 and GStreamer (appears to be defunct).
  • Buildroot Submodule. Not a fork, but a convenience layer on top of buildroot.
  • Experimental 'shell' around Buildroot. Another wrapper around Buildroot, to help manage projects.

Todo list

This is a list of improvements that we would like to see in buildroot. Feel free to add suggestions here. If you're working on one of these items, put your name and the date behind it, to avoid duplicate work.

There are a number of patches that have been determined to be useful but for various reasons nobody currently has time to review or test them. Anybody, especially a person new to buildroot, is welcome to adopt these patches and resubmit them to the mailing list.

Perpetual work

Some jobs are never finished. When you have a bit of uninterrupted time you would like to spend on Buildroot, you can pick one of these things.

Autobuild failures

The autobuild failures are random configurations for which the build fails. This is what we want to fix. A summary of failures is sent daily to the mailing list, this gives a good summary of the most frequently failing packages.

  • Go to the failing output ("end log" link) and see if it's an error message that you can make sense of. Often you can't, then just skip it and look for something else.
  • Check on patchwork if a fix was already posted. Also check in recent commit history if a fix was already committed. Also ask on IRC if someone is working on it.
  • Reproduce the issue with the br-reproduce-build script. However, it is often easier to first attempt to reproduce it by simply downloading the defconfig as .config, run make olddefconfig, then make <the package that fails>. Not all issues can be reproduced this way however! Also, if the failing configuration was using a Buildroot toolchain rather than an external toolchain, it can be worth to first try to reproduce with an external toolchain (which reduces the build time by quite a lot).
  • Produce a fix. Here are some hints.
    • Perhaps the package simply doesn't support that configuration (target architecture, libc type, static build, threads, GCC version) and a dependency has to be added in Config.in.
    • Sometimes a fix was already found by someone else and sent upstream, so check its bugs list, pull requests and recent commits. Also check if OpenEmbedded has a fix already.
    • Sometimes a similar issue was recently fixed for another package, so you can git log --grep '<some part of the error message>'.
  • Test the fix with the actual configuration (so no switching to external toolchain any more). Do a full clean build.
  • Check your changes with the utils/check-package script.
  • Post your fix according to the contribution guidelines in the manual.

See this commit for an example of what the commit message should look like. Important is to have:

  • the compilation error;
  • the Fixes: line;
  • your Signed-off-by.

Update CVE exceptions

Buildroot keeps track of which CVEs apply to each package, based on a CPE ID. However, many CVEs don't actually apply. In particular very old CVEs are likely not to be applicable to the version currently shipped in Buildroot.

  • Look at the package statistics. Sort by "CVEs". Look for a package with old CVEs.
  • For each CVE, check if it really applies.
  • If not, update the package's FOO_IGNORE_CVES with the CVE to ignore. Commit with a commit message that explains in detail why the CVE can be ignored. Example commit message.
  • If the CVE really applies, check if there is an upstream patch fixing it.
  • Check your changes with the utils/check-package script.
  • Post your fix according to the contribution guidelines in the manual.

Packages

Note: if you start working on any of these packages, please edit this section to indicate it. If the package is proposed in a bug report, please also update the bug report. Sending a mail to the mailing list also never hurts, you never know that someone else started working on it without following this guideline.

Important

Nice to have

Toolchain

Documentation

  • Convert the documentation + the generation workflow from current asciidoc to either markdown or ReStructuredText (people are nowadays more used to that syntax, and they are formatted directly when viewed in gitlab/github).
  • Document how to contribute (how often to repost, what to expect, ...) basic guide
  • Document that package patches should be sent upstream

Core Buildroot infrastructure

  • Cargo and Go post-process handling for vendoring
    • Add support for tarball formats other than gz
  • Several improvements are possible in the download infrastructure (even after all the improvements that were already done):
    • Rename the downloaded files so they include the package name and version. Special care has to be taken for primary and secondary sites, and for extra downloads (including patches).
    • Split between FOO_SITE and FOO_SOURCE shouldn't be necessary. Or it could be made optional, i.e. make it possible to specify the full path in FOO_SOURCE.
  • Add instrumentation scripts to analyse package installed files:
    • find libraries with wrong RPATH/RUNPATH tags
    • detect unused .so libs (eg. shared libs that are not DT_NEEDED by anything - note: only detect those libs, don't remove: can be used as plugin (dlopen), or used by an application built outside Buildroot)
  • A script that checks consistency of depends/select for packages. Maybe it can be integrated to the current check-package.

Testing infrastructure

  • Fix run-tests to use a config file for download and output directories, can be overridden in the environment
  • Documentation on how to add a test, including naming convention

TODO items under discussion

Here are some nice-to-have's for which it is not entirely clear if and how they could be implemented:

  • Out-of-tree builds, which allows the package source to be shared between different output directories and between host and target compiles.
  • It would be nice if you could run a buildroot command that prepares a local copy of a package's source, and allows you to generate patches for it later. This could use git or quilt to keep track of the patches.
  • It would be nice if there was a make target to reinstall everything to the target (i.e. remove all the target-installed stamps, remove the root stamp, maybe remove the target too). However, what is missing is the copying of the toolchain support files (libc.so etc.). It's not obvious that this can be done in a reliable way.
  • To facilitate debugging, all packages should be installed to the staging directory. The target directory should in fact be a subset of the staging directory. See the FOSDEM 2013 discussion at http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013, and the discussion around patch http://patchwork.ozlabs.org/patch/252718/. This is however a significant change in Buildroot, so probably difficult to implement, and will raise a number of quite complicated questions.