diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 59b4d9607a..21403c072c 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -619,6 +619,15 @@ +
+ <filename>do_kernel_metadata</filename> + + + Collects kernel metadata for a + linux-yocto style kernel. + +
+
<filename>do_menuconfig</filename> @@ -638,6 +647,14 @@
+
+ <filename>do_shared_workdir</filename> + + + Creates the shared working directory for the kernel. + +
+
<filename>do_sizecheck</filename> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index fbdd3c0850..7cc01c64ef 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -6454,6 +6454,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + KERNEL_ALT_IMAGETYPE + + KERNEL_ALT_IMAGETYPE[doc] = "Specifies an alternate kernel image type for creation." + + + + + Specifies an alternate kernel image type for creation in + addition to the kernel image type specified using the + KERNEL_IMAGETYPE + variable. + + + + KERNEL_CLASSES KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." @@ -6475,6 +6490,34 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + KERNEL_DEVICETREE + + KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the .dtb) file." + + + + + Specifies the name of the generated Linux kernel device tree + (i.e. the .dtb) file. + + Legacy support exists for specifying the full path + to the device tree. + However, providing just the .dtb + file is preferred. + + In order to use this variable, you must have the include + files in your kernel recipe: + + require recipes-kernel/linux/linux-dtb.inc + + or + + require recipes-kernel/linux/linux-yocto.inc + + + + + KERNEL_EXTRA_ARGS KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." @@ -6604,6 +6647,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" when building the kernel and is passed to make as the target to build. + + + If you want to build an alternate kernel image type, use the + KERNEL_ALT_IMAGETYPE + variable. + @@ -6742,6 +6791,46 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + KERNEL_VERSION + + KERNEL_VERSION[doc] = "Specifies the version of the kernel as extracted from version.h or utsrelease.h within the kernel sources." + + + + + Specifies the version of the kernel as extracted from + version.h or + utsrelease.h within the kernel sources. + Effects of setting this variable do not take affect until + the kernel has been configured. + Consequently, attempting to refer to this variable in + contexts prior to configuration will not work. + + + + + KERNELDEPMODDEPEND + + KERNELDEPMODDEPEND[doc] = "Specifies whether or not to use the data referenced through the PKGDATA_DIR directory." + + + + + Specifies whether the data referenced through + PKGDATA_DIR + is needed or not. + The KERNELDEPMODDEPEND does not + control whether or not that data exists, + but simply whether or not it is used. + If you do not need to use the data, set the + KERNELDEPMODDEPEND variable in your + initramfs recipe. + Setting the variable there when the data is not needed + avoids a potential dependency loop. + + + + KFEATURE_DESCRIPTION KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." @@ -11735,6 +11824,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + STAGING_KERNEL_BUILDDIR + + STAGING_KERNEL_BUILDDIR[doc] = "Points to the directory containing the kernel build artifacts." + + + + + Points to the directory containing the kernel build + artifacts. + Recipes building software that needs to access kernel + build artifacts + (e.g. systemtap-uprobes) can look in + the directory specified with the + STAGING_KERNEL_BUILDDIR variable to + find these artifacts after the kernel has been built. + + + + STAGING_KERNEL_DIR STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules."