diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 1cdf902d08..9420050f06 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -1293,6 +1293,38 @@ + CONFIG_INITRAMFS_SOURCE + + + Identifies the initial RAM disk (initramfs) source files. + The OpenEmbedded build system receives and uses + this kernel Kconfig variable as an environment variable. + By default, the variable is set to null (""). + + + + The CONFIG_INITRAMFS_SOURCE can be + either a single cpio archive with a + .cpio suffix or a + space-separated list of directories and files for building + the initramfs image. + A cpio archive should contain a filesystem archive + to be used as an initramfs image. + Directories should contain a filesystem layout to be + included in the initramfs image. + Files should contain entries according to the format + described by the + usr/gen_init_cpio program in the + kernel tree. + + + + If you specify multiple directories and files, the + initramfs image will be the aggregate of all of them. + + + + CONFIG_SITE @@ -3312,6 +3344,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" is run through an extra pass during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs). + Using an extra compilation pass ensures that when a kernel + attempts to use an initramfs, it does not encounter + circular dependencies should the initramfs include kernel + modules. + + + The combined binary is deposited into the tmp/deploy directory, which is part of the