Commit Graph

1435 Commits

Author SHA1 Message Date
Peter Korsgaard
1c0da88a83 Update for 2022.08-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-01 10:19:48 +02:00
Peter Korsgaard
02104e86cc docs/website: update for 2022.02.5
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-09-01 00:05:37 +02:00
Peter Korsgaard
0f2c0c24d3 docs/website/news.html: correct 2022.05.1 entry
This was naturally 2022.05.1, NOT 2021.05.1.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-08-31 21:09:42 +02:00
Peter Korsgaard
5fddfefb3f docs/website: update for 2022.05.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-08-31 21:09:15 +02:00
Julien Olivain
5ac1b1866d docs/manual: patch subjects shall not be numbered
The script "utils/check-package" checks that patch email prefix are
not be numbered. See:
https://git.buildroot.org/buildroot/tree/utils/checkpackagelib/lib_patch.py?h=2022.08-rc1#n42

The error message recommends to generate patches to be included in
Buildroot with the command 'git format-patch -N'.

The patch policy section in the Buildroot manual does mention that.

This commit adds a note about that requirement.

Signed-off-by: Julien Olivain <ju.o@free.fr>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-08-28 11:51:23 +02:00
Julien Olivain
7652817c93 docs/manual/prerequisite.txt: add findutils in dependencies
The "find" and "xargs" commands, from the "findutils" package are used
during the build process. See for example [1].

Even if it's a quite common package which is almost sure to be present
on the host, it should be listed here. When writing new recipes, hooks
and scripts, it is generally safe and portable to restrict to the
host dependencies listed in those prerequisites.

This commit just add the missing "findutils" package in this list.

[1] https://git.buildroot.org/buildroot/tree/Makefile?h=2022.05.1#n737

Signed-off-by: Julien Olivain <ju.o@free.fr>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-08-15 22:21:33 +02:00
Thomas Petazzoni
a09e9f0c18 Update for 2022.08-rc1
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-08-12 21:31:20 +02:00
Thomas Petazzoni
ae6e144405 docs/manual/ccache-support.txt: document the new BR2_USE_CCACHE variable
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-30 13:45:16 +02:00
Thomas Petazzoni
a2689d901b docs/manual/ccache-support.txt: expand explanation about ccache cache location
The manual explanation seemed to imply that the cache is always in
~/.buildroot-ccache/, but it's just the default value. Clarify this
point.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-30 12:34:48 +02:00
Thomas Petazzoni
c857b8ff0e Makefile, docs/manual, support, toolchain: remove Eclipse integration
Back many years ago, we developed an Eclipse plugin that simplified
the usage of Buildroot toolchains. Enabling the BR2_ECLIPSE_REGISTER=y
was registering the Buildroot toolchain into a special file in your
HOME folder that the Eclipse plugin would recognize to allow to
directly use the Buildroot cross-compiler.

This Eclipse plugin has not been maintained for years. The last commit
in the repository dates back from September 2017. Since then Eclipse
has moved on, and the plugin is no longer compatible with current
versions of Eclipse.

Also, Eclipse is probably no longer that widely used in the embedded
Linux space, as other more modern IDEs have become more popular.

All in all, it's time to say good bye to this Eclipse integration.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-30 12:32:41 +02:00
Arnout Vandecappelle (Essensium/Mind)
32b341fa34 docs/manual: add integration section for systemd with dbus
Add a section to the "Integration topics" chapter about how we integrate
systemd. Add a first subsection about how dbus and dbus-broker work with
systemd.

This is just the start of the integration information about systemd.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-29 22:45:11 +02:00
Arnout Vandecappelle (Essensium/Mind)
15c972f32a docs/manual: introduce "Integration topics" chapter
We want to add more information in the manual about how a system created
with buildroot works overall. We currently already have a chapter about
SELinux, but we want to add more information like that, e.g. details
about how systemd in Buildroot works.

Create a new chapter "Integration topics" with an introductory blurb,
and move the SELinux topic under it (as a section rather than a
chapter).

"Integration topics" is not the best title, but we couldn't find
anything better.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
[yann.morin.1998@free.fr: remove selinux from main manual.txt]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-29 22:44:10 +02:00
Peter Korsgaard
88d36b83f0 docs/website: update for 2022.02.4
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-07-29 12:03:34 +02:00
Peter Korsgaard
5eccf75a7c docs/website: update for 2022.05.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-07-28 10:59:22 +02:00
José Luis Salvador Rufo
f3d5916a9f docs/manual/prerequisite.txt: add diffutils
The command `cmp` is used by `package/pkg-generic.mk` at commit
8623cc5deb. This command is provided by `diffutils`, so it should be
installed on the host system.

Signed-off-by: José Luis Salvador Rufo <salvador.joseluis@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-07-26 23:57:16 +02:00
Fabrice Fontaine
002f0e927d docs/manual: fix patchwork URL
http://patchwork.buildroot.org is redirecting to
https://bugs.busybox.net so replace it by
https://patchwork.ozlabs.org/project/buildroot/list/ as already done in
docs/website/contribute.html

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-07-23 18:57:22 +02:00
Thomas Petazzoni
47f359a615 utils/get-developers: implement a -v action for DEVELOPERS file validation
Commit "45aabcddc5 utils/get-developers: really make it callable from
elsewhere than the toplevel directory" had a unforeseen side-effect:
the fact that check-developers with no arguments used to validate the
syntax of the DEVELOPERS no longer works. Indeed, the
parse_developers() call was moved *after* the check that verifies if
at least one action is passed. Due to this, the check-DEVELOPERS
verification in Gitlab CI, which invokes get-developers without
argument to validate the DEVELOPERS file... no longer does anything
useful.

In order to fix this, we introduce an explicit action in
get-developers to request the validation of the DEVELOPERS file. The
implementation is trivial, as the validation is already done by
calling parse_developers(), but at least now we have an action that
does "nothing", except execute until the validation is done.

This is also much more explicit than "invoke get-developers without
arguments to just do validation".

The initial investigation of the issue was done by Ricardo Martincoski
<ricardo.martincoski@gmail.com> and reported at
https://patchwork.ozlabs.org/project/buildroot/patch/20220528014832.289907-1-ricardo.martincoski@gmail.com/,
but we have chosen to introduce a separate -v option rather than
making the validation part of the existing -c action, which serves a
different purpose.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2022-07-23 16:32:58 +02:00
Thomas Petazzoni
4c6e7a134f docs/manual: update documentation about partition-type-uuid convention in genimage.cfg
Whenever possible, we want to use the "shortcuts" provided by genimage
for the partition-type-uuid values:

 - U for the EFI System Partition
 - F for FAT32 partitions
 - L for root filesystem partitions and other Linux filesystems

In follow-up commits, we will convert existing genimage.cfg to this
convention, except for the root filesystem, if the existing
genimage.cfg specifies a partition-type-uuid that doesn't match the
one that "L" would imply. In this case, we will keep things as-is to
not break existing setups. However, for all future genimage.cfg files,
we recommend to use "L" for the root filesystem.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-07-23 15:36:21 +02:00
Nicolas POIROT
5c5f30cbc7 docs/manual: fix configurations listing command
Signed-off-by: Nicolas POIROT <ni.poirot@laposte.net>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-06-22 22:09:26 +02:00
Thomas Petazzoni
793ee1011e Remove support for the NDS32 architecture
The support for this architecture has been removed from the upstream
Linux kernel, as of commit:

  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=aec499c75cf8e0b599be4d559e6922b613085f8f

Which states:

  The nds32 architecture, also known as AndeStar V3, is a custom
  32-bit RISC target designed by Andes Technologies. Support was added
  to the kernel in 2016 as the replacement RISC-V based V5 processors
  were already announced, and maintained by (current or former) Andes
  employees.

  As explained by Alan Kao, new customers are now all using RISC-V,
  and all known nds32 users are already on longterm stable kernels
  provided by Andes, with no development work going into mainline
  support any more.

There has also been little to no maintenance done in Buildroot for
this architecture in recent times, so let's follow the Linux kernel
community decision and drop support for this CPU architecture.

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Reviewed-by: Yu Chien Peter Lin <peterlin@andestech.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-06-19 18:30:45 +02:00
Peter Korsgaard
3ebac8f3c3 docs/website: update for 2022.02.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-06-19 13:10:00 +02:00
Peter Korsgaard
6081e7e53d docs/website/news.html: add 2022.05 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-06-06 23:12:45 +02:00
Peter Korsgaard
730baf05bf Update for 2022.05
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-06-06 22:14:04 +02:00
Quentin Schulz
dd66a2f0b1 manual: add _TARGET_FINALIZE_HOOKS in the list of hooks
While reading the docs to find hooks, I completely missed the
LIBFOO_TARGET_FINALIZE_HOOKS one which was actually matching my
use-case.

Though it is documented in a subsection a few lines below, let's also
have it in the list of supported hooks so it's not hidden away.

Cc: Quentin Schulz <foss+buildroot@0leil.net>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-06-04 11:30:42 +02:00
Peter Korsgaard
b7d8ce5b18 Update for 2022.05-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-05-30 18:27:29 +02:00
Peter Korsgaard
601323915e docs/website: update for 2022.02.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-05-29 22:54:54 +02:00
Arnout Vandecappelle (Essensium/Mind)
8b51205638 docs/manual/makeusers-syntax.txt: add caveat for upgrading
With the change of the range of UIDs that is generated from the
automatic ID (-1), it became apparent that there is a potential problem
with these automatic IDs when upgrading: they may have changed, which
means that persistent files that exist outside of the rootfs suddenly
have a different owner.

Add a caveat section to the manual, as well as an explanation of how to
work around the problem.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
[yann.morin.1998@free.fr: slight rewording]
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
2022-05-28 23:43:15 +02:00
Peter Korsgaard
ae4e99aa9e Update for 2022.05-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-05-18 11:03:29 +02:00
James Hilliard
d4723bb9bd docs/manual: document flit/pep517 python package infrastructure
Note that the flit-bootstrap SETUP_TYPE is deliberately not
documented as it is used only for bootstrapping the host pep517
toolchain and should not be used anywhere else.

Signed-off-by: James Hilliard <james.hilliard1@gmail.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-05-04 21:47:37 +02:00
Peter Korsgaard
1b718adee4 docs/website: update for 2022.02.1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-04-13 00:13:08 +02:00
Peter Korsgaard
e2eb6ed72c docs/website: update for 2021.02.12
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-04-07 10:36:27 +02:00
Peter Korsgaard
16008ee1c0 docs/website: update for 2021.02.11
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-25 14:17:04 +01:00
Peter Korsgaard
2a7a2c7617 docs/website: update for 2021.11.3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-24 23:31:52 +01:00
Yannick Brosseau
db2b8a1ce2 docs/manual: Remove link to emdebian and replace with debian port page
In the list of full distribution, the FAQ contains a link to Emdebian.
This project stopped receiving updates in 2014 and the main web page does not exist anymore.
This replace the entry with a link to the Debian ports page.

Signed-off-by: Yannick Brosseau <yannick.brosseau@gmail.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-03-15 22:28:01 +01:00
Peter Korsgaard
501263241c docs/website/news.html: add 2022.02 announcement link
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-09 13:55:32 +01:00
Peter Korsgaard
08967921c4 Update for 2022.02
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-08 23:08:11 +01:00
Giulio Benetti
1e1976a25d manual: board support: add instructions to test defconfig in the official docker
Sometimes new boards have not been tested with official docker so let's add
instructions to do it with utils/docker-run.

Cc: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-03-07 22:48:02 +01:00
Yann E. MORIN
6b59ed35a2 package/pkg-cargo: allow building in a sub-directory
Some packages have their rust sources as a sub-directory, rather
than at the root of the source tree.

Do like we do for autotools-package, and use the package's _SRCDIR
rather than the top-level directory $(@D).

Additionally, in such a situation, it is more than probable that
the Cargo.toml is also present in that sub-directory, so use that
when vendoring the package.

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-07 22:04:54 +01:00
Simon Doppler
ca9e55ad11 docs/manual: Document Kconfig requirements for uboot
When using uboot's legacy build system, the 'make uboot-menuconfig'
and 'make uboot-savedefconfig' targets are not available as they
are created by 'kconfig-package'.

Signed-off-by: Simon Doppler <dopsi@dopsi.ch>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-07 21:36:03 +01:00
Théo Lebrun
efcb7eeabc docs: fix links to AsciiDoc
Links were aimed at the methods.co.nz domain, which is now returning
404s. The current situation of AsciiDoc is unclear to me: the Fedora
package points to this website, they own asciidoc.org, Wikipedia points
to this project as well but their Git repo's README includes the
following paragraph:

> AsciiDoc.py is a legacy processor for this syntax, handling an older
> rendition of AsciiDoc. As such, this will not properly handle the
> current AsciiDoc specification. It is suggested that unless you
> specifically require the AsciiDoc.py toolchain, you should find a
> processor that handles the modern AsciiDoc syntax.

https://github.com/asciidoc-py/asciidoc-py/blob/10.1.3/README.md

"AsciiDoc specification" pointing towards:
https://projects.eclipse.org/projects/asciidoc.asciidoc-lang

Signed-off-by: Théo Lebrun <theo.lebrun@bootlin.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-07 20:26:24 +01:00
Fabrice Fontaine
3d7f852ac5 docs/manual: remove override in conditional
Remove override of FOO_{CONF_OPTS,DEPENDENCIES} in conditional

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-03-05 17:27:04 +01:00
Peter Korsgaard
5b6e2ee8b7 Update for 2022.02-rc3
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-28 22:38:26 +01:00
Peter Korsgaard
0c4d496bf1 docs/website: update for 2021.02.10
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-28 22:17:20 +01:00
Peter Korsgaard
746d00ef9f docs/website: update for 2021.11.2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-28 22:11:49 +01:00
Peter Korsgaard
f3d0d7e6ff Update for 2022.02-rc2
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-20 23:24:46 +01:00
Peter Korsgaard
5ee6be2bdc Update for 2022.02-rc1
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-13 20:50:48 +01:00
Giulio Benetti
46beca0656 docs/manual: fix "+size = +" latex formatting
Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-02-13 16:21:03 +01:00
Yann E. MORIN
4f59ababc0 package/doc-asciidoc: fix build for out-of-tree documents
The doc-asciidoc infra allows document to define sources and resources,
and those can only be local (there is no download support for documents).
The currently documented way to specify those is to use the $(pkgdir)
macro to point to the document sources and resources when they are along
the .mk.

However, this works only for sources and not for resources.

Indeed, sources are used to generate Makefile dependency rules, so
$(pkgdir) is expanded and evaluated during the call to $(doc-asciidoc),
while resources are expanded and evaluated when the rules are executed,
which always happen after all the parsing has be done, at which point
$(pkgdir) expands to the last Makefile that was parsed, which is always
Buildroot's own manual.

This went unnoticed so far because Buildroot's manual is 1) the last to
be parsed, and 2) not using $(pkgdir) anyway.

Additionally, $(pkgdir) is mostly an internal macro, that is, as this
change demonstrates, difficult to use, and thus should not be used, in
packages or in documents.

We fix that by introducing $(FOO_DOCDIR), similar to $(FOO_PKGDIR),
which points to the document directory. We choose not to name the
variable FOO_PKGDIR, because it semantically is not a package.

As a consequence, the last argument to the doc-asciidoc macro is now
superfluous, so it is removed, which causes a little bit of churn in
the main macro. As a further consequence, the third argument in the
inner macro is no longer needed either, so it too is removed, which
causes a bit more churn yet in the inner macro.

Signed-off-by: Yann E. MORIN <yann.morin@orange.com>
Cc: Frederic GARDES <frederic.gardes@orange.com>
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2022-02-13 12:24:02 +01:00
Peter Korsgaard
2615732124 docs/manual/adding-packages-python.txt: drop <pkg>_NEEDS_HOST_PYTHON
Now that host-python2 is gone and the corresponding logic in pkg-python.

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-13 12:11:50 +01:00
Giulio Benetti
a3529b8020 docs/manual/adding-packages-generic: remove useless carriage return
Signed-off-by: Giulio Benetti <giulio.benetti@benettiengineering.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
2022-02-11 10:10:18 +01:00