[v2,5/5] docs: Update custom_kernel docs for split up of kernel scripts and tools

Message ID 20221220170921.1718503-6-stefan-koch@siemens.com
State Superseded, archived
Headers show
Series linux-custom: Split up binaries from kernel headers to kbuild packages | expand

Commit Message

Koch, Stefan Dec. 20, 2022, 5:09 p.m. UTC
Signed-off-by: Stefan Koch <stefan-koch@siemens.com>
---
 doc/custom_kernel.md | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

Patch

diff --git a/doc/custom_kernel.md b/doc/custom_kernel.md
index ffeaddc..1328c70 100644
--- a/doc/custom_kernel.md
+++ b/doc/custom_kernel.md
@@ -38,12 +38,18 @@  The linux-custom recipe provides support for:
  7. Allow the name of the kernel image to be changed via `KERNEL_FILE` (defaults
     to `vmlinuz`)
 
- 8. Produce a `linux-headers` package which includes kernel headers and kbuild
-    scripts/tools
-
- 9. The `linux-headers` package shall support native and cross compiles of
-    out-of-tree kernel modules. However, when built in cross-compilation mode,
-    it cannot be used on the target so far.
+ 8. Produce a `linux-headers` package which includes kernel headers
+
+ 9. Produce a `linux-kbuild` package for both host and/or target
+    which includes kbuild scripts and tools.
+    Appending `ISAR_BUILDS` with `"target"` will enable the
+    build of a target specific kbuild package at cross builds.
+    Then the `linux-headers` package supports native and cross compiles of
+    out-of-tree kernel modules. Even, when built in cross-compilation mode,
+    it can be used on the target using the `linux-kbuild` package.
+    Appending `ISAR_BUILDS` with `"host"` will enable the
+    build of a host specific kbuild package at cross builds.
+    In this case no kbuild-cross package will be generated.
 
  10. Produce a `linux-libc-dev` package to support user-land builds
 
@@ -71,8 +77,6 @@  In the future, the recipe may be extended to:
 
  3. Be compatible with Ubuntu
 
- 4. When cross-building, generate kernel-headers for both host and target
-
 ## Examples
 
 The linux-custom recipe is currently used by the linux-mainline package and is