diff mbox series

docs/manual: promote using fixed version for kernel headers when contributing a board

Message ID 20240403213135.699268-1-gero.schwaericke@posteo.de
State New
Headers show
Series docs/manual: promote using fixed version for kernel headers when contributing a board | expand

Commit Message

Gero Schwäricke April 3, 2024, 9:30 p.m. UTC 
When the default (newest) kernel headers series changes the build can
break. Example error message:

  Incorrect selection of kernel headers: expected 6.8.x, got 6.5.x

In the above case the defconfig used:

  BR2_LINUX_KERNEL_CUSTOM_VERSION=y
  BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE="6.5.9"

The kernel headers were not specified, so the build defaulted to using
the kernel sources as header source and the default (newest) header
series. From .config:

  BR2_KERNEL_HEADERS_AS_KERNEL=y
  BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_6_8=y

Signed-off-by: Gero Schwäricke <gero.schwaericke@posteo.de>
---
 docs/manual/adding-board-support.adoc | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/docs/manual/adding-board-support.adoc b/docs/manual/adding-board-support.adoc
index ef6dbd3c2b..85fd0815a8 100644
--- a/docs/manual/adding-board-support.adoc
+++ b/docs/manual/adding-board-support.adoc
@@ -32,7 +32,11 @@  Always use fixed versions or commit hashes for the different
 components, not the "latest" version. For example, set
 +BR2_LINUX_KERNEL_CUSTOM_VERSION=y+ and
 +BR2_LINUX_KERNEL_CUSTOM_VERSION_VALUE+ to the kernel version you tested
-with.
+with. If you are using the buildroot toolchain +BR2_TOOLCHAIN_BUILDROOT+
+(default) additionally ensure that the kernel headers
++BR2_KERNEL_HEADERS_*+ and (if applicable) the custom kernel headers
+series +BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_*+ match your kernel
+version.
 
 It is recommended to use as much as possible upstream versions of the
 Linux kernel and bootloaders, and to use as much as possible default