Commit Graph

1663 Commits

Author SHA1 Message Date
Thomas Perale
096589bd59 docs/manual: mention CVE trailer
Adds documentation about adding a patch that address a vulnerability.

The patch-policy file now explain mention that patches that address a
vulnerability needs to include a `CVE:` trailer with the reference of
that vulnerability.

Until now only adding the reference to the `_IGNORE_CVES` variable was
necessary, so the documentation of this entry is modified as well to
point to the patch policy.

Signed-off-by: Thomas Perale <thomas.perale@mind.be>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 1167d0ff3d225ca9ce2b6299da28a9307d370142)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-12-18 16:56:23 +01:00
Thomas Perale
ac0a735d99 docs/manual: add information on CycloneDX
This patch adds information on how to generate a CycloneDX SBOM in
Buildroot. It also mentions how to track CVEs with that given SBOM.

Signed-off-by: Thomas Perale <thomas.perale@mind.be>
[Peter: reword slightly]
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit e09bf9e951)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-11-26 09:44:11 +01:00
Alexis Lothoré
6b55553337 docs/manual: update old git links to proper gitlab location
Some links are still pointing to git.buildroot.org, which is the old URL
for the official Buildroot git repository. The repository is now hosted
at gitlab.com. Update those old links accordingly.

Signed-off-by: Alexis Lothoré <alexis.lothore@bootlin.com>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit 3ae80441ed)
Signed-off-by: Titouan Christophe <titouan.christophe@mind.be>
2025-09-30 10:21:02 +02:00
Alexis Lothoré
9faeb6e9a2 docs/manual: update links to buildroot.org from http to https
Many links pointing to buildroot.org are still prefixed with HTTP.
Update those to HTTPS.

Signed-off-by: Alexis Lothoré <alexis.lothore@bootlin.com>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit 6f29c81703)
Signed-off-by: Titouan Christophe <titouan.christophe@mind.be>
2025-09-30 10:20:54 +02:00
Alexis Lothoré
3072f0ae88 docs/manual/getting: fix dead link
When searching for the official git repository in the documentation,
readers are forwarded to the buildroot website Download page with a link
pointing to buildroot.org/download, which returns a 404.

Fix the dead link by adding the missing .html suffix.

Signed-off-by: Alexis Lothoré <alexis.lothore@bootlin.com>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit 8845586fc6)
Signed-off-by: Titouan Christophe <titouan.christophe@mind.be>
2025-09-30 10:19:36 +02:00
Florian Larysch
608a20d7f3 docs/manual: mention checkpackageignore file
Currently, the manual doesn't mention the checkpackageignore file at
all, leaving the user under the assumption that running "make
check-package" and running utils/check-package directly on the package
they have touched would be equivalent, when the former evaluates the
checkpackageignore file while the latter does not. This could cause them
to forget to remove stale entries from that file.

Point out this difference in behavior.

Signed-off-by: Florian Larysch <fl@n621.de>
[Arnout: add that stale lines should be removed from
.checkpackageignore]
Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
(cherry picked from commit 47181a164c)
Signed-off-by: Titouan Christophe <titouan.christophe@mind.be>
2025-09-04 13:57:24 +02:00
Giulio Benetti
f8d4073c21 Update Benetti Engineering URLs to new ones
The company name was changed from "benetti-engineering-sas" to "benetti-engineering"
to be agnostic to the company legal form. Update all GitHub and LinkedIn links
accordingly.

Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit c38ea1d496)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-08-21 10:33:37 +02:00
Francois Perrad
2a63098209 docs/manual/customize-directory-structure.adoc: suggest a custom top Makefile
Signed-off-by: Francois Perrad <francois.perrad@gadz.org>
[Arnout: give a bit more explanation, simplify the example]
Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
(cherry picked from commit 36f9436488)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-27 18:36:13 +02:00
Guillaume Chaye
89c82ec8e8 support/download/dl-wrapper: add basic support for smb file download using curl
It allows to download files from smb share in buildroot packages.
Usage is specified in manual.

Signed-off-by: Guillaume Chaye <guillaume.chaye@zeetim.com>
[Peter: reword documentation]
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit e240b889f1)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-27 18:24:29 +02:00
Arnout Vandecappelle
47206093c2 docs/manual/adding-packages-tips.adoc: add section about private repositories
Buildroot packaging pretty much assumes that the sources it downloads
are publicly available. In general, however, Buildroot is also used to
download sources from private repositories. Nowadays, that mostly means
from a github or gitlab instance.

Although git-over-ssh can be used for that, this poses a problem for CI,
because the CI runners integrated with github and gitlab only have
access to the repository itself, not to other private repositories. And
creating ssh key pairs for CI runners is tricky.

Therefore, document how standard tools can be used to make private
repositories available both to developers and to CI. There are quite a
few alternative approaches possible, but they're more complicated or
less generically applicable.

Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
[Peter: Fix insteadOf example, capitalize SSH/HTTPS]
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
(cherry picked from commit 1026abbcf9)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-26 17:49:45 +02:00
Marcus Hoffmann
6a0a963a9d docs/manual/adding-packages-python.adoc: clarify how _BUILD_OPTS work
PYTHON_FOO_BUILD_OPTS are passed to the build module call of the package
build, this allows passing options to the python build *backend* by
using the --config-setting= option. setup.py is no longer involved since
even the setuptools backend now used the pep517 build method.

The note about the options being passed to
support/scripts/pyinstaller.py seems to be no longer accurate.

Signed-off-by: Marcus Hoffmann <buildroot@bubu1.eu>
[Arnout: also mention -C (suggested by James)]
Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
(cherry picked from commit b15cd1d8fe)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-26 17:45:38 +02:00
Thomas Petazzoni
b8a4a82cb6 support/dependencies/dependencies.sh: awk is needed by Buildroot
A basic Fedora 42 container does not have 'awk' installed, but it is
needed by Buildroot. First by check-host-python3.sh:

support/dependencies/check-host-python3.sh: line 6: awk: command not found
support/dependencies/check-host-python3.sh: line 19: awk: command not found
support/dependencies/check-host-python3.sh: line 19: awk: command not found

but then even building host-expat assumes awk is available:

config.status: creating Makefile
./config.status: line 1404: awk: command not found
config.status: creating expat.pc
./config.status: line 1404: awk: command not found

Since it's a pretty basic tool, make it part of the tools checked by
dependencies.sh. One minor annoyance is that check-host-python3.sh is
executed *before* dependencies.sh does its thing, so when 'awk' is not
available, we end up seeing:

support/dependencies/check-host-python3.sh: line 6: awk: command not found
support/dependencies/check-host-python3.sh: line 19: awk: command not found
support/dependencies/check-host-python3.sh: line 19: awk: command not found
which: no awk in (/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin)
You must install 'awk' on your build machine
make: *** [support/dependencies/dependencies.mk:27: dependencies] Error 1

It would be nice to have the awk check *before* it gets used in
check-host-python3.sh, but that's a topic for another patch.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit 448ceefa78)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-15 17:05:49 +02:00
Yann E. MORIN
fb287340b7 support/download/git: use FOO_DL_OPTS
The manual states that FOO_DL_OPTS are valid for all the different
download backends, but that is not the case: at least the git backend
does not use them (it does not fail, it just ignores them).

Accept FOO_DL_OPTS in the git backend, and pass them to 'git fetch'.
There is no way that we can pass such options to submodules or lfs,
though.

Update the manual accordingly.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
(cherry picked from commit a1012b363a)
Signed-off-by: Thomas Perale <thomas.perale@mind.be>
2025-05-02 12:12:31 +02:00
Arnout Vandecappelle
f0a67991c0 docs/website: add current LTS sponsors
Add the LTS sponsors who engaged already for 2025: EVS, Open Home
Foundation, and Sense Labs. There is one more sponsor but they prefer to
remain anonymous.

For Open Home Foundation, we can reuse the existing logo. For the other
two, add their logo.

Add a new class panel-lts-sponsor for sizing the panels. It is different
from panel-sponsor because there doesn't need to be space for an
explanation of what type of sponsorship is done, we just need to have
space for the company name. So the minimum height is 200px instead of
350px.

Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit b111e07fd5)
2025-04-06 17:21:07 +02:00
Arnout Vandecappelle
e66ca1741d docs/website/images/openhomefoundation-logo.png: crop for better layout
The Open Home Foundation logo is in a white area that is too large for
how we display it on the sponsors page. As a result, it ends up at the
bottom of the logo area and it looks very unbalanced.

Crop the logo to a tigher area. Since it is going to end up being
scaled, it's difficult to predict what the best size it is, but cropping
at a height of 300 pixels gives a visually pleasing layout at at least
some resolutions.

Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
Signed-off-by: Julien Olivain <ju.o@free.fr>
(cherry picked from commit e287bc7f44)
2025-04-06 17:21:07 +02:00
Peter Korsgaard
aa2d7ca53f Update for 2025.02
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-03-17 18:54:20 +01:00
Peter Korsgaard
873407b46c docs/website/news.html: refer to gitlab bug tracker
We moved the issue tracking to gitlab some time ago.  Adjust the bug tracker
references in news.html to point to there instead of bugzilla for clarity.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-03-13 11:40:10 +01:00
Peter Korsgaard
53f74f49c0 Update for 2025.02-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-03-13 11:09:27 +01:00
Peter Korsgaard
a031b51637 Update for 2025.02-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-02-28 17:27:41 +01:00
Yann E. MORIN
dcb5d1d918 package/pkg-golang: allow packages to provide extldflags
Currently, only the -static extldflags may be set in the
golang-package infra. However, in some cases, it might be necessary to
pass other flags, either because they are needed on a specific
architecture, or a specific C library; packages may also have a need
to pass arbitrary linker flags when they use CGO linking.

For example, on AArch64, go forcibly uses ld.gold, but it is not
available in all toolchains, and ld.bfd works nowadays (following
patch); another case is musl, where PIE is not supported with go.

Introduce FOO_EXTLDFLAGS, which we use to set those flags, and that
packages can set to pass such flags.

Migrate the current setting of -static to use that new variable.

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Tested-by: Nathaniel Roach <nroach44@nroach44.id.au>
Signed-off-by: Fiona Klute (WIWA) <fiona.klute@gmx.de>
Reviewed-by: Yann E. MORIN <yann.morin@orange.com>
Reviewed-by: Christian Stewart <christian@aperture.us>
Signed-off-by: Romain Naour <romain.naour@smile.fr>
2025-02-22 22:18:28 +01:00
Peter Korsgaard
2f0c31bffd docs/website: Update for 2024.11.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-02-21 15:53:51 +01:00
Peter Korsgaard
ca47c95118 docs/website: Update for 2024.02.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-02-21 15:51:39 +01:00
Francois Perrad
3ef139386d package: add support for <pkg>_BUSYBOX_CONFIG_FIXUPS
This will allow individual packages to define extra Busybox options
that they need.

Signed-off-by: Francois Perrad <francois.perrad@gadz.org>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2025-02-04 17:33:35 +01:00
Adam Duskett
67c6d1b12c package/mender: bump version to 3.5.3
Updating directly to 4.x is too difficult and complex, as mender 4.x is
a complete rewrite in C++, with several new dependencies and changes.

As such, update to the last version that was written in Go, which is
3.5.3. The following changes are necessary:

The artifact_info file is no longer supported. Instead, mender now expects a
bootstrap.mender artifact created by mender-artifact /var/lib/mender.
See the following for more information:
https://northerntech.atlassian.net/browse/MEN-2585
https://northerntech.atlassian.net/browse/MEN-2583
https://docs.mender.io/release-information/release-notes-changelog/mender-client#mender-3-5-0-1
https://github.com/mendersoftware/mender/blob/3.5.3/Documentation/automatic-bootstrap-artifact.md

  - Remove all instances of creating or copying an artifact_info file
    from board examples and package/mender.

  - Add a generate_mender_bootstrap_artifact method to
    board/mender/x86_64/post-image-efi.sh which creates a proper
    bootstrap.mender file and places it in the data partition.

  - Add a post-build.sh script to support/testing/tests/package/test_mender
    with the same generate_mender_bootstrap_artifact method with one change:
    As the rootfs.ext4 file is not yet created; we omit the optional
    --provides "rootfs-image.checksum:${img_checksum}" argument when
    generating the bootstrap.mender file.

Mender expects the device_type file to exist in /var/lib/mender/device_type.
  This is further supported by the following line in tests/Dockerfile.daemon:
  `echo device_type=docker-client > /var/lib/mender/device_type`

Add a migration section in docs/manual/migrating.adoc

Update the package/mender/readme.txt to include a quick mention of the
bootstrap.mender artifact change.

License changes:

New:
vendor/github.com/klauspost/compress/internal/snapref/LICENSE (BSD-3-Clause)
vendor/github.com/klauspost/compress/zstd/internal/xxhash/LICENSE.txt (MIT)

Removed:
vendor/github.com/klauspost/compress/internal/snapref/LICENSE
vendor/github.com/klauspost/compress/zstd/internal/xxhash/LICENSE.txt

Modified:
LICENSE: Update year from 2022 to 2024
LIC_FILES_CHKSUM.sha256: Sum of all Licenses changed
vendor/github.com/mendersoftware/mender-artifact/LICENSE
  - Update year from 2022 to 2023

Signed-off-by: Adam Duskett <adam.duskett@amarulasolutions.com>
[Arnout:
  - fix LIC_FILES_CHKSUM.sha256 hash
  - Better URL for bootstrap artifact doc
  - Migrate to 2025.02 instead of 2024.11
  - Improve migrating text (editorial changes)
]
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2025-02-04 15:00:19 +01:00
Thomas Petazzoni
225ea56e8f docs/website: fix </div> soup
Commit bdcdc4428c got the div soup
wrong, adjust this.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2025-02-03 14:21:09 +01:00
Thomas Petazzoni
bdcdc4428c docs/website: add Open Home Foundation to the sponsors
The Open Home Foundation generously sponsored the Buildroot project
end of 2024, credit them.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2025-02-03 14:17:21 +01:00
Peter Korsgaard
d81b579d99 docs/website: Update for 2024.11.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-01-09 16:32:19 +01:00
Peter Korsgaard
9d3d12b6b5 docs/website: Update for 2024.02.10
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2025-01-09 15:05:33 +01:00
Peter Korsgaard
a836ca88b4 docs/website: Update for 2024.02.9
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-12-08 22:24:54 +01:00
Peter Korsgaard
eb24a208f7 docs/website: Update for 2024.08.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-12-08 21:12:26 +01:00
Peter Korsgaard
ef33e6bce6 docs/website/news.html: add 2024.11 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-12-08 13:59:35 +01:00
Peter Korsgaard
8f9ce0c913 Update for 2024.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-12-08 11:18:01 +01:00
Peter Korsgaard
0901a670a8 Update for 2024.11-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-12-05 18:06:59 +01:00
Peter Korsgaard
b617eb3281 docs/website/news.html: refer to gitlab for buildroot-test repo
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-23 11:40:14 +01:00
Peter Korsgaard
366d403bed docs/website/news.html: use gitlab for all CHANGES links
We migrated to Gitlab a while ago, so update the CHANGES links to point to
that rather than git.buildroot.net.

Automated with:

sed -i 's|http://git.buildroot.net/buildroot/plain/CHANGES?id=\([^"]*\)|https://gitlab.com/buildroot.org/buildroot/-/blob/\1/CHANGES|g' \
 docs/website/news.html

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-23 11:36:10 +01:00
Peter Korsgaard
81d111dbd4 Update for 2024.11-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-23 11:00:53 +01:00
Peter Korsgaard
b4ae65e36e docs/website: Update for 2024.02.8
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-14 17:39:32 +01:00
Peter Korsgaard
a7ed78badc docs/website: Update for 2024.08.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-14 14:50:12 +01:00
Peter Korsgaard
46fa2fcb7a Update for 2024.11-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-11-13 18:59:29 +01:00
James Hilliard
0205f4c2b8 package/pkg-python.mk: add poetry setup type
As we have many python packages using the poetry(poetry-core) build
system we should add a setup type for it so that we don't have to
manually specify the host-python-poetry-core dependency.

Signed-off-by: James Hilliard <james.hilliard1@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-11-04 23:19:55 +01:00
Thomas Petazzoni
b07ee5e41c docs/website: fix the link to the mailman archives
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-28 21:56:04 +01:00
Fiona Klute (WIWA)
67249a691d docs/manual/adding-packages-directory: describe start script details
This codifies style elements discussed on the mailing list, most
importantly PID file handling, and adds detailed considerations for
writing start scripts.

References:
https://lore.kernel.org/buildroot/20240712124956.3925574-1-fiona.klute@gmx.de/
https://lore.kernel.org/buildroot/20240714223645.39adf8c6@windsurf/
https://lore.kernel.org/buildroot/9ec13ac0-b5b6-4251-98b8-0d8f7adac452@gmx.de/

Signed-off-by: Fiona Klute (WIWA) <fiona.klute@gmx.de>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-28 21:51:27 +01:00
Brandon Maier
68de69c4d7 docs/manual/adding-packages-tips: mention check-package requirements
Call out the requirements to run check-package and mention that Docker
can be used to run check-package without installing dependencies.

Signed-off-by: Brandon Maier <brandon.maier@collins.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-26 13:37:38 +02:00
Thomas Petazzoni
bcd0e6f4c2 docs/website/news.html: announce Buildroot Developers Meeting 2025
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-24 23:04:22 +02:00
Thomas Petazzoni
523f6c2ca9 docs/website/sponsors.html: update sponsors information
Move Logilin to past sponsors, update details about Smile sponsoring
and Armadeus sponsoring, and likewise for a number of past sponsors.

The text about Smile as a past sponsor is reworded/reduced so that it
stills fits in the size of the block in a reasonable way.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-24 22:31:53 +02:00
Thomas Petazzoni
d9df4bbbc1 docs/website/sponsors.html: fix page layout
The LTS block was glued with the next block, add missing </div>.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-24 22:31:49 +02:00
James Hilliard
1459c0a6f0 package/pkg-python.mk: add hatch setup type
As we have many python packages using the hatch(hatchling) build
system we should add a setup type for it so that we don't have to
manually specify the host-python-hatchling dependency.

Signed-off-by: James Hilliard <james.hilliard1@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-10-23 23:00:03 +02:00
Peter Korsgaard
848c86a7ce docs/website: Update for 2024.02.7
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-10-21 09:53:03 +02:00
Peter Korsgaard
0b71467930 docs/website: Update for 2024.08.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2024-10-21 08:40:24 +02:00
Yann E. MORIN
17bdd10cb3 docs/manual: do not instruct doctoring the saved defconfig
Doctoring a defconfig is tedious, and it is not easy to update a
defconfig, as it requires manual copy-pasting, adding comments and so
on...

Instead, just require defconfigs to be generated with 'savedefconfig'.
Any details can/must be provided in the commit log.

Reported-by: Edgar Bonet <bonet@grenoble.cnrs.fr>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Signed-off-by: Arnout Vandecappelle <arnout@mind.be>
2024-10-02 20:28:30 +02:00